Grunnleggende bruk
Send din første Gender API-forespørsel
Send én verdi og motta predikert kjønn, sannsynlighet, land og bruksinformasjon. Start med et navn, og bruk det egne endepunktet for e-post eller brukernavn når det er datatypen du har.
Legg til API-nøkkelen med spørringsparameteren key. Oppbevar produksjonsnøkler på serveren – aldri eksponer en privat nøkkel i nettleserkode eller et offentlig repository.
Bruk den gjeldende GenderAPI-kontrakten i OpenAPI-, Swagger- eller Postman-format.
Kjønn fra navn
Fornavn eller fullt navn
Bruk basisendepunktet når inndataene er et fornavn eller fullt navn.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"Valgfrie parametere
| Parameter | Type | Beskrivelse |
|---|---|---|
country | string | Landkode med to bokstaver, for eksempel NO eller US. |
askToAI | boolean | Når verdien er true, vurderes AI som reserve dersom navnet ikke finnes i databasen. |
forceToGenderize | boolean | Forsøker en prediksjon for uvanlige inndata som kanskje ikke ligner personnavn. |
Kjønn fra e-post
E-postadresse
E-postendepunktet trekker ut et sannsynlig navn fra adressen før kjønnsprediksjonen utføres.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=NO&askToAI=true&key=YOUR_API_KEY"forceToGenderize er ikke tilgjengelig for dette endepunktet fordi navnet trekkes ut internt.Kjønn fra brukernavn
Brukernavn i sosiale medier
Bruk endepunktet for brukernavn, kontoidentifikatorer og kallenavn som kan inneholde et kjent navn.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=NO&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-svar
Forstå svaret fra GenderAPI
Alle tre endepunktene bruker den samme grunnleggende svarstrukturen.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "NO",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Svarfelt
| Felt | Type | Beskrivelse |
|---|---|---|
status | boolean | Angir om forespørselen ble fullført. |
used_credits | integer | Antall kreditter som forespørselen brukte. |
remaining_credits | integer | Antall kreditter som gjenstår etter forespørselen. |
expires | integer | Pakkens utløpstid som et UNIX-tidsstempel. |
q | string | Den opprinnelige forespørselen med navn, e-post eller brukernavn. |
name | string | Det normaliserte eller utledede fornavnet. |
gender | string | Predikert kjønn: male, female eller "null". |
country | string | Mest sannsynlige ISO 3166-1 alfa-2-landkode. |
total_names | integer | Antall navneposter som prediksjonen bygger på. |
probability | integer | Prediksjonens sannsynlighet angitt i prosent. |
duration | string | Serverens behandlingstid for forespørselen. |
URL-kod alltid inndataverdier
Mellomrom og spesialtegn må kodes av HTTP-klienten. Bruk for eksempel sparkling%20unicorn i stedet for et vanlig mellomrom.
Fortsett implementeringen