API DOCUMENTATIE V2

Migreren van GenderAPI v1 naar v2

Verplaats een GenderAPI-integratie van v1 naar v2 met dezelfde API-sleutel en balans. Breng aanvraagvelden, batchroutes, reacties, fouten en gedrag voor nieuwe pogingen in kaart.

Verplaats een integratie van v1 naar v2

V1 blijft beschikbaar. Migreer individuele integraties wanneer u klaar bent met dezelfde sleutel en hetzelfde tegoed. V2 is een ander request-and-response-contract, dus alleen de URL wijzigen is niet voldoende.

V1-conceptV2-equivalent
Aparte eindpunten voor naam, e-mailadres en gebruikersnaamPOST /api/v2/gender met type en value
Scheid meerdere eindpuntenPOST /api/v2/gender/batch met items
askToAIoptions.ai_mode: fallback; enkele verzoeken zijn al standaard ingesteld op fallback
forceToGenderizeHetzelfde optionele veld voor alle drie de typen; eerst de dataset en daarna de bijnaambewuste AI
Platte responsveldendata voor het resultaat; meta voor toegang en facturering
probability-percentageconfidence op een schaal van 0–1 plus confidence_kind; AI-scores zijn geen gekalibreerde kansen
total_namesdata.sample_count, nullbaar
used_credits / remaining_creditsmeta.usage.charged_credits / remaining_credits
Verouderd foutformaatHTTP-status plus Problem Details code en action
POST nieuwe pogingElke nieuwe poging is een nieuwe handeling met normale facturering

Update en verifieer uw client

Gebruik het v2 request and response-contract voor de integratie die u migreert. Verifieer meta.access.mode, bewaar JSON null-resultaten, inspecteer batchfouten per item en controleer de facturering voordat u het opnieuw probeert. Houd v1-integraties op hun bestaande paden totdat hun clients zijn bijgewerkt.