Hjälp för GenderAPI.io V2
Vanliga frågor
Svar om V2-förfrågningar, konfidens, okända resultat, krediter, integritet och konto. Om du underhåller en integration med den tidigare versionen använder du V1-dokumentationen.
Resultat och konfidens
Förstå prediktioner och deras begränsningar
Landskontext, konfidensvärden och okända resultat i API V2.
Fastställer ett resultat från GenderAPI en persons kön?
Nej. GenderAPI härleder kön från namnrelaterade signaler eller, när alternativet är aktiverat, från signaler i smeknamn. En prediktion är inget verifierat faktum om en person. Behåll osäkerheten, respektera den könsidentitet som en person själv uppger och grunda inte beslut med betydande konsekvenser enbart på denna uppskattning.
Hur påverkar landskontexten ett resultat?
En valfri ISO-landskod med versaler ger förfrågan regional kontext. Ange den bara när den är relevant och känd. Samma namn kan användas olika i olika regioner; det returnerade landet beskriver en koppling till namnet och är inget bevis på medborgarskap eller bosättning.
Vad betyder konfidensvärdet i V2?
confidence är ett värde från 0 till 1, eller null när inget värde finns. Läs det tillsammans med confidence_kind: observed_frequency anger antalet för den dominerande kategorin i datamängden delat med det totala antalet; model_reported är ett värde som AI har rapporterat. Dessa värden är inte kalibrerade sannolikheter om en person och inte en uppmätt produktnoggrannhet. Fastställ granskningströsklar utifrån representativa data.
Vad betyder gender: null, och debiteras ett sådant resultat?
Ett lyckat V2-resultat med gender: null betyder att de tillgängliga signalerna inte kunde fastställa något kön. Det är det inbyggda JSON-värdet null, inte strängen "null". Ett lyckat okänt resultat debiteras enligt kostnaden för det valda läget. Behandla det som okänt; ett leverantörs- eller förfrågningsfel är ett separat felfall.
Kan jag skicka namn i olika skriftsystem?
Ja. Skicka namn som Unicode med de ursprungliga tecknen och betydelsebärande diakritiska tecken. Täckning och konfidens beror på namn, region och tillgängliga signaler. Testa därför ett representativt urval av de skriftsystem och länder som din applikation omfattar.
API och AI
Välj typ av förfrågan och AI-alternativ
Typer av V2-förfrågningar, batchar, AI-beteende och användningsgränser.
Kan jag analysera namn, e-postadresser och användarnamn i en batch?
Ja. POST /api/v2/gender/batch tar emot upp till 50 poster med API-nyckel eller 10 i IP-provperioden. Varje post har egna fält type och value, ett valfritt country och egna AI-inställningar. Som standard är AI avstängd för batchposter. Kontrollera varje resultat: en batch kan returnera HTTP 200 även om enskilda poster har misslyckats. Krediter debiteras per lyckat bearbetad post, även för okända resultat.
Hur fungerar en förfrågan med en e-postadress?
Använd type: email med en giltig adress. API:et söker efter en användbar namnsignal i den lokala delen före @-tecknet; domänen säger ingenting om en persons identitet eller land. Delade brevlådor och adresser utan namnsignal kan ge ett okänt resultat. En enskild förfrågan använder som standard AI när datamängden inte ger något resultat.
Hur fungerar en förfrågan med ett användarnamn?
Använd type: username. En vanlig förfrågan söker efter ett igenkännbart förnamn i ett användarnamn eller visningsnamn. Abstrakta alias kan ge ett okänt resultat. Aktivera forceToGenderize om AI med analys av smeknamn ska användas efter en resultatlös kontroll av datamängden; på så sätt kan ett kön fastställas utan att ett riktigt förnamn extraheras.
När använder V2 AI?
Enskilda förfrågningar använder som standard options.ai_mode: fallback: datamängden kontrolleras först, och om inget kön fastställs används AI, för totalt 1 kredit. off använder endast datamängden för 1 kredit; always hoppar över datamängden och använder AI för 2 krediter. Batchposter använder off som standard och kan aktivera AI var för sig. Inget av dessa lägen garanterar ett resultat som inte är null.
Vad gör forceToGenderize?
Den här valfria flaggan fungerar med namn, e-postadresser och användarnamn, även i enskilda batchposter. Ett resultat som fastställs i datamängden kostar 1 kredit. Annars används AI med analys av smeknamn, för totalt 2 krediter, även om det lyckade resultatet förblir okänt. Ett riktigt förnamn krävs inte. Utelämna ai_mode eller använd fallback; att kombinera flaggan med off eller always ger 422.
Hur debiteras krediter i V2?
Läs meta.usage.charged_credits för de krediter som faktiskt debiterats för en åtgärd och billing_status för bekräftelsen av debiteringen. Vanliga prediktioner från datamängden och i läget fallback kostar 1 kredit per lyckat bearbetad post; always och AI med analys av smeknamn kostar 2 krediter. En slutförd validering av ett telefonnummer kostar 1 kredit, även vid ett ogiltigt resultat. Ett positivt startsaldo räcker, så den slutliga debiteringen kan göra saldot negativt. Krediter för misslyckade prediktioner återbetalas; en obekräftad debitering måste granskas av supporten.
Finns det gränser för förfrågningar i V2?
Ja. De aktuella standardvärdena är 120 förfrågningar per minut och konto, 600 per minut och IP-adress samt 2 samtidiga åtgärder per konto. Dessutom gäller tjänstens gemensamma kapacitet. POST-förfrågningar är begränsade till 64 KiB; batchar tillåter 50 poster med nyckel eller 10 i IP-provperioden. Hantera HTTP 429 och Retry-After i stället för att anta att förfrågningar upp till dessa gränser alltid accepteras.
Kan jag upprepa en misslyckad förfrågan eller en förfrågan som har överskridit tidsgränsen?
Varje prediktionsförfrågan är en ny åtgärd och debiteras som vanligt. En överskriden tidsgräns eller ett förlorat svar bevisar inte att inga krediter har debiterats. Kontrollera billing_status innan du försöker igen; om debiteringen inte är bekräftad kontaktar du supporten med request_id. Vid en delvis misslyckad batch upprepar du bara de misslyckade posterna när debiteringen är bekräftad. Vid 429 ska du respektera rubriken Retry-After.
Var hittar jag kodexempel och verktyg för V2?
V2-guiderna innehåller exempel i cURL, JavaScript, Python, PHP, Java, C# och Go. Swagger och Postman använder samma V2-kontrakt. Välj typ av indata och förvara din API-nyckel i konfigurationen på serversidan.
Kan jag fortsätta att använda V1?
Ja. Befintliga V1-integrationer behåller sina tidigare endpoints och svarsformat. V1 och V2 använder samma API-nyckel och samma saldo, men skiljer sig åt i förfrågningsfält, svar och fel. Använd den separata V1-dokumentationen för att underhålla en befintlig klient och migreringsguiden när du vill byta.
Integritet och filer
Förstå hur data behandlas
Var du hittar aktuell information om behandling, lagring och radering.
Sparas lyckade förfrågningar till GenderAPI?
Integritetspolicyn förklarar vilka förfrågningsdata, driftdata och säkerhetsloggar som kan lagras, i vilket syfte de behandlas och hur radering sker. Kontrollera dessa uppgifter för din integration och skicka inga onödiga personuppgifter.
Sparas e-postadresser från förfrågningar?
Integritetspolicyn beskriver hur e-postadresser från förfrågningar och tillhörande tekniska data hanteras. En e-postadress kan vara en personuppgift: skicka bara det som förfrågan kräver och spara inte fullständiga adresser i dina egna diagnostikloggar.
Hur länge sparas uppladdade Excel- eller CSV-filer?
Integritetspolicyn fastställer lagring, radering och säkerhetskopior av uppladdade filer. Exportera de resultat du behöver och radera filen med funktionerna i arbetsytan när du inte längre behöver den. Kontakta supporten om du har frågor om din organisations krav på lagring.
Får tjänsteleverantörer behandla data från förfrågningar eller uppladdade filer?
Integritetspolicyn och informationen om underbiträden beskriver hur tjänsteleverantörer behandlar data och vilka skyddsåtgärder som gäller. Granska dessa dokument och varje avtal som gäller för ditt konto när du bedömer var dina data behandlas.
Konto och support
Anslut nycklar och hantera ditt konto
Kostnadsfri åtkomst, autentisering, saldokontroll och support.
Kan jag testa GenderAPI kostnadsfritt?
Ja. Ett registrerat kostnadsfritt konto innehåller 200 krediter per dag. Oberoende av detta ger IP-provperioden i V2 utan nyckel 10 krediter per offentlig IP-adress inom 24 timmar, som delas med V1 och med andra användare av samma IP-adress. I båda fallen gäller de vanliga kostnaderna; antalet krediter motsvarar inte alltid antalet HTTP-förfrågningar.
Hur autentiserar jag mig och skyddar min API-nyckel?
Använd Authorization: Bearer YOUR_API_KEY i betrodd kod på serversidan; POST-förfrågningar kräver dessutom Content-Type: application/json. Håll den riktiga nyckeln borta från webbläsarkod, offentliga repositorier och loggar. Saknade, felformaterade eller okända nycklar kan leda till IP-provperioden; kontrollera därför att meta.access.mode har värdet api_key. Kända nycklar som är inaktiverade, har gått ut eller är begränsade växlar inte till provperioden.
Hur kontrollerar jag mina återstående krediter?
Anropa GET /api/v2/usage med din Bearer-nyckel. Den här saldokontrollen är kostnadsfri och returnerar data.remaining_credits. Utan nyckel läses det delade saldot för IP-provperioden. V1 och V2 använder samma kontosaldo; värdet remaining_credits i en prediktion visar saldot vid den tidpunkt då åtgärden slutfördes.
Var kan jag hantera eller säga upp en prenumeration?
Logga in i GenderAPI-applikationen för att hantera den prenumeration som är kopplad till din API-nyckel. I de aktuella kontoinställningarna ser du ditt paket och alternativen för uppsägning.
Var kan jag ändra mina faktureringsuppgifter?
Inställningar för fakturering och betalning hanterar du efter inloggning i GenderAPI-applikationen för respektive API-nyckel eller prenumeration.
Hur rapporterar jag ett felaktigt resultat eller får hjälp med en integration?
Skicka API-version, endpoint, request_id och ett kort reproducerbart exempel till supporten. Ange felkoden om det finns en, men ta bort din API-nyckel och känsliga personuppgifter.
Teknisk kunskapsbas
Guider för implementering och ansvarsfull användning
Svar om resultat, integritet och drift av V2, med länkar till guiderna och en Markdown-version av varje svar.
Resultat, konfidens och ansvarsfull användning
En olöst V2-prediktion returnerar det inbyggda JSON-värdet null för gender, inte strängen "null". Ett namn kan vara tvetydigt eller så räcker de tillgängliga signalerna inte; kontrollera result_status och reason när de finns. Behåll det okända resultatet i stället för att tvinga in det i en kategori. En lyckad prediktion utan resultat debiteras enligt kostnaden för det valda läget. Förfrågnings- eller leverantörsfel är separata felfall; uppgifter om hur de debiteras finns i meta.usage.
Läs hela svaret →Hur utvärderas GenderAPI:s noggrannhet?En meningsfull utvärdering av noggrannheten anger den undersökta populationen, datumet, urvalsmetoden, andelen okända resultat samt resultat per region och skriftsystem. Den aktuella metodiksidan beskriver ett utvärderingsprotokoll, inte ett uppmätt noggrannhetsvärde i procent. V2-fälten confidence och confidence_kind förklarar vilka signaler ett resultat bygger på; de ersätter inte en utvärdering med representativa data.
Läs hela svaret →Datakällor, integritet och regelefterlevnad
Sidan om datans ursprung beskriver ramarna för att dokumentera källkategorier, urvalskriterier, licenser samt geografiska och skriftrelaterade begränsningar. Någon granskad källförteckning publiceras inte där för närvarande. Läs den sidan och kontakta supporten om din integration har källrelaterade krav; utgå inte från källor, datamängdsstorlekar eller täckningsvärden som inte är dokumenterade.
Läs hela svaret →Hur ofta uppdateras namndata?Den aktuella sidan om datans ursprung anger inget enhetligt uppdateringsschema för alla namnposter eller bearbetningsregler. Om aktualiteten är viktig för ditt användningsfall frågar du supporten om den aktuella datamängden eller processen och kontrollerar representativa resultat. Granskningsdatumet på en sida visar inte att alla underliggande poster uppdaterades den dagen.
Läs hela svaret →Var hittar jag information om GDPR och personuppgiftsbiträdesavtalet?Integritetspolicyn, informationen om GDPR, personuppgiftsbiträdesavtalet och förteckningen över underbiträden beskriver de publicerade villkoren för behandling och skyddsåtgärderna. Granska de aktuella dokumenten och varje avtal som gäller för ditt konto. Vid organisationsspecifika frågor, till exempel om roller i behandlingen, överföringar av uppgifter eller begäranden från registrerade, kontaktar du GenderAPI; en allmän FAQ ersätter inte det gällande avtalet.
Läs hela svaret →API-drift, fel och debitering
Använd Authorization: Bearer YOUR_API_KEY i betrodd kod på serversidan. POST-förfrågningar i V2 kräver dessutom Content-Type: application/json. GET /api/v2/gender accepterar även en nyckel som frågeparameter, men rubriker förhindrar att inloggningsuppgifter syns i webbläsarens URL:er. Saknade, felformaterade eller okända nycklar kan leda till den delade IP-provperioden; kontrollera i en kontointegration att meta.access.mode har värdet api_key. Kända nycklar som är inaktiverade, har gått ut eller är begränsade växlar inte till en provperiod.
Läs hela svaret →Hur hanterar jag gränser för förfrågningar och nya försök?V2 tillämpar gränser för antal förfrågningar och för samtidiga förfrågningar; hantera HTTP 429 och Retry-After. Varje upprepad prediktion är en ny åtgärd och debiteras som vanligt. Upprepa inte automatiskt förfrågningar efter en överskriden tidsgräns, ett förlorat svar eller en obekräftad debitering. Kontrollera först code, action och meta.usage.billing_status; vid billing_reconciliation_required kontaktar du supporten med request_id. Använd begränsad backoff endast när debiteringen är bekräftad och den dokumenterade action tillåter ett nytt försök.
Läs hela svaret →Hur tolkar jag V2-fel?Fel i V2-API:et använder HTTP-felstatuskoder och Problem Details enligt RFC 9457 med de stabila fälten code och action. Utgå från dessa fält i stället för att matcha formuleringen i detail, och spara request_id för supporten. Ett lyckat okänt resultat är inget fel. Batchsvar kan innehålla fel för enskilda poster även vid HTTP 200. En proxy kan returnera ett fel i ett annat format än JSON, och ett förlorat eller oläsligt svar visar inte att inga krediter har debiterats.
Läs hela svaret →Hur kontrollerar jag mina återstående krediter?Anropa GET /api/v2/usage med din API-nyckel i Bearer-rubriken från betrodd kod på serversidan. Den här förfrågan är kostnadsfri och returnerar data.remaining_credits; utan nyckel läses den delade IP-provperioden. V1 och V2 använder samma kontosaldo. Fältet meta.usage i en prediktion anger kostnaden för den åtgärden och saldot vid den tidpunkt då den slutfördes, vilket kan ändras vid samtidiga förfrågningar. Håll inloggningsuppgifter borta från loggar och se inte en saldokontroll som bevis för att en viss förfrågan med förlorat svar inte debiterades.
Läs hela svaret →Hur byter jag från V1 till V2 utan avbrott?Bygg nya integrationer med V2 och låt befintliga V1-klienter använda sina dokumenterade endpoints tills du vill byta. Båda versionerna använder samma API-nycklar och krediter men skiljer sig åt i förfrågningsfält, svarsstrukturer och felformat. Följ migreringsguiden, testa lyckade, okända och felaktiga resultat och anpassa din hantering av svar innan du byter endpoint. V1-dokumentationen är fortfarande tillgänglig för befintliga integrationer.
Läs hela svaret →Hur felsöker jag fel och övervakar tjänstens tillgänglighet?När förfrågningar misslyckas använder du den returnerade felkoden för att skilja mellan driftstörningar, ogiltiga indata, problem med kontoåtkomst, förbrukade krediter och gränser för förfrågningar. Övervaka andelen lyckade förfrågningar och svarstiden i din egen integration. Kontakta supporten med request_id vid ett oförklarligt fel eller en oklar debitering. Grunda påståenden om tillgänglighet på mätresultat; denna FAQ anger inget garanterat tillgänglighetsvärde i procent.
Läs hela svaret →Behöver du mer hjälp?
Skicka ett reproducerbart exempel
Ange endpoint, förfrågningsparametrar och returnerat fel, men skicka inte din API-nyckel för produktion eller känsliga personuppgifter.