API-documentatie Unified API v2.0

API v1.0

We bieden ook een andere API-versie aan met eindpunten die gemakkelijker te integreren zijn. Als je een beginner bent in het implementeren van API's, kun je overschakelen naar ons endpoint v1.0.
Bekijk API v1.0

OpenAPI

Bekijk onze API-documentatie in Swagger

Postman

Importeer onze API-definitie in Postman
Zoek op voornaam
Zoeken op volledige naam
Zoek op e-mailadres
Haal het land van oorsprong op
Bekijk statistieken
Foutcodes

Zoek op voornaam

Dit is de gemakkelijkste manier om het geslacht van een naam op te zoeken. Elke respons is in JSON-indeling gecodeerd:

Bericht
Aanvraag vereist: 1
URL
https://gender-api.com/v2/gender
Headers
Content-Type: application/json
Authorization: Bearer <uw autorisatietoken>
link
JSON Payload
Veld Type Verplicht Beschrijving
first_name string Ja Naam om op te vragen
country string Nee ISO 3166 ALPHA-2 landcode
link
locale string Nee Browser Taalinstelling
ip string Nee Geldig IPv4 of IPv6 adres
id string Nee Max 50 tekens. Je kunt deze id instellen op elke alfanumerieke waarde die je wilt. Als voorbeeld kun je de id instellen op je interne id van de dataset in je database. In een asynchroon omgeving kan dit je helpen om de respons beter te verbinden met een eerdere aanvraag

Voorbeelden

Opzoeken op voornaam alleen
play_arrow Testen live met codepen.io 
{"first_name":"Sandra"}
Opzoeken op voornaam en landcode
play_arrow Testen live met codepen.io 
{"first_name":"Sandra","country":"US"}
Zoekopdracht op voornaam en browsertaal
play_arrow Testen live met codepen.io 
{"first_name":"Sandra","locale":"en_US"}
Zoekopdracht op voornaam en gebruik een IP-adres voor lokalisatie
play_arrow Testen live met codepen.io 
{"first_name":"Sandra","ip":"54.201.16.177"}
Meerdere namen zoeken in één verzoek
play_arrow Testen live met codepen.io 
[{"first_name":"Sandra","country":"US"},{"first_name":"Jason","country":"US"}]
Reactie
{
    "input": {
        "first_name": "Sandra"
    },
    "details": {
        "credits_used": 1,
        "samples": 464,
        "country": null,
        "first_name_sanitized": "sandra",
        "duration": "436ms"
    },
    "result_found": true,
    "first_name": "Sandra",
    "probability": 0.85,
    "gender": "female"
}
Veld Type Beschrijving
input object De ingediende payload
details.credits_used int Het aantal verzoeken dat voor deze query is gebruikt
details.samples int Aantal gevonden records in onze database die overeenkomen met uw verzoek
details.country string Het land dat we hebben gevonden
details.first_name_sanitized string De naam nadat we onze normalisator erop hebben toegepast
details.duration string Tijd die de server nodig had om het verzoek te verwerken
result_found bool True als we een gender hebben kunnen vinden voor de gegeven naam
first_name string De voornaam die we gebruikten voor genderclassificatie
probability float Deze waarde (tussen 0 en 1) bepaalt de betrouwbaarheid van onze database. Een waarde van 1 betekent dat de resultaten van uw genderverzoek 100% nauwkeurig zijn.
gender string Mogelijke waarden: mannelijk, vrouwelijk, onbekend
Dit product bevat GeoLite2-gegevens die zijn gemaakt door MaxMind, beschikbaar op http://www.maxmind.com.
Chat