Ondersteuning voor GenderAPI.io V2

Lees als Markdown

Veelgestelde vragen

Antwoorden over V2-verzoeken, de betrouwbaarheidsscore, onbekende resultaten, credits, privacy en uw account. Beheert u een integratie met de vorige versie, gebruik dan de V1-documentatie.

Resultaten en betrouwbaarheid

Voorspellingen en hun grenzen begrijpen

Landcontext, betrouwbaarheidsscores en onbekende resultaten in de V2-API.

Stelt een GenderAPI-resultaat het geslacht van een persoon vast?

Nee. GenderAPI leidt het geslacht af uit signalen die bij een naam horen of, wanneer die optie is ingeschakeld, uit signalen in bijnamen. Een voorspelling is geen geverifieerd gegeven over een persoon. Behoud de onzekerheid, respecteer de genderidentiteit die iemand zelf opgeeft en baseer ingrijpende beslissingen niet alleen op deze schatting.

Hoe beïnvloedt landcontext een resultaat?

Een optionele ISO-landcode in hoofdletters geeft het verzoek regionale context. Geef deze alleen mee wanneer het land relevant en bekend is. Dezelfde naam kan per regio anders worden gebruikt; het teruggegeven land beschrijft een verband met de naam en bewijst geen nationaliteit of woonplaats.

Wat betekent de betrouwbaarheidsscore in V2?

confidence is een waarde van 0 tot 1, of null wanneer er geen waarde beschikbaar is. Lees deze samen met confidence_kind: observed_frequency is het aantal van de meest voorkomende categorie in de dataset gedeeld door het totale aantal; model_reported is een waarde die door AI wordt opgegeven. Deze waarden zijn geen gekalibreerde kansen over een persoon en geen gemeten productnauwkeurigheid. Stel beoordelingsdrempels vast op basis van representatieve gegevens.

Wat betekent gender: null en wordt dit resultaat gefactureerd?

Een succesvol V2-resultaat met gender: null betekent dat de beschikbare signalen onvoldoende waren om het geslacht te bepalen. Het gaat om de native JSON-waarde null, niet om de tekenreeks "null". Een succesvol onbekend resultaat wordt gefactureerd tegen het tarief van de gekozen modus. Behandel het als onbekend; een fout van de provider of van het verzoek is een afzonderlijk foutgeval.

Kan ik namen in verschillende schriften versturen?

Ja. Verstuur namen in Unicode met de oorspronkelijke tekens en betekenisvolle diakritische tekens. Dekking en betrouwbaarheidsscore hangen af van de naam, de regio en de beschikbare signalen. Test daarom een representatieve steekproef van de schriften en landen die uw applicatie verwerkt.

API en AI

Kies het soort verzoek en de AI-opties

V2-verzoektypen, batches, AI-gedrag en gebruikslimieten.

Kan ik namen, e-mailadressen en gebruikersnamen in een batch analyseren?

Ja. POST /api/v2/gender/batch accepteert maximaal 50 items met een API-sleutel of 10 met de IP-proefperiode. Elk item heeft eigen velden type en value, een optioneel country en eigen AI-instellingen. Standaard staat AI uit voor batchitems. Controleer elk resultaat: een batch kan HTTP 200 teruggeven, ook als afzonderlijke items zijn mislukt. Credits worden per succesvol verwerkt item afgeschreven, ook voor onbekende resultaten.

Hoe werkt een verzoek met een e-mailadres?

Gebruik type: email met een geldig adres. De API zoekt een bruikbaar naamsignaal in het lokale deel vóór de @; het domein zegt niets over de identiteit of het land van een persoon. Gedeelde mailboxen en adressen zonder naamsignaal kunnen een onbekend resultaat opleveren. Een los verzoek gebruikt standaard AI wanneer de dataset geen resultaat oplevert.

Hoe werkt een verzoek met een gebruikersnaam?

Gebruik type: username. Een normaal verzoek zoekt een herkenbare naam in een gebruikersnaam of weergavenaam. Abstracte aliassen kunnen een onbekend resultaat opleveren. Schakel forceToGenderize in als u wilt dat na een controle in de dataset zonder resultaat AI met bijnaamanalyse wordt gebruikt; zo kan het geslacht ook worden bepaald zonder dat een echte voornaam wordt gevonden.

Wanneer gebruikt V2 AI?

Losse verzoeken gebruiken standaard options.ai_mode: fallback: eerst wordt de dataset geraadpleegd en als het geslacht daar niet wordt bepaald, wordt AI gebruikt, voor in totaal 1 credit. off gebruikt alleen de dataset voor 1 credit; always slaat de dataset over en gebruikt AI voor 2 credits. Batchitems gebruiken standaard off en kunnen AI per item inschakelen. Geen van deze modi garandeert een resultaat dat niet null is.

Wat doet forceToGenderize?

Deze optionele vlag werkt met namen, e-mailadressen en gebruikersnamen, ook in afzonderlijke batchitems. Een resultaat dat uit de dataset wordt bepaald, kost 1 credit. Anders wordt AI met bijnaamanalyse gebruikt, voor in totaal 2 credits, ook als het succesvolle resultaat onbekend blijft. Een echte voornaam is niet nodig. Laat ai_mode weg of gebruik fallback; de vlag combineren met off of always geeft 422 terug.

Hoe worden credits in V2 afgeschreven?

Lees meta.usage.charged_credits voor de credits die voor een bewerking daadwerkelijk zijn afgeschreven en billing_status voor de bevestiging van de afschrijving. Normale voorspellingen uit de dataset en in de modus fallback kosten 1 credit per succesvol verwerkt item; always en AI met bijnaamanalyse kosten 2 credits. Een voltooide validatie van een telefoonnummer kost 1 credit, ook bij een ongeldig resultaat. Een positief startsaldo is voldoende, dus de uiteindelijke afschrijving kan het saldo negatief maken. Credits voor mislukte voorspellingen worden teruggeboekt; een onbevestigde afschrijving moet door support worden gecontroleerd.

Gelden er verzoeklimieten in V2?

Ja. De huidige standaardwaarden zijn 120 verzoeken per minuut per account, 600 per minuut per IP-adres en 2 gelijktijdige bewerkingen per account. Daarnaast geldt de gedeelde capaciteit van de dienst. POST-verzoeken zijn beperkt tot 64 KiB; batches accepteren 50 items met een sleutel of 10 met de IP-proefperiode. Verwerk HTTP 429 en Retry-After in plaats van ervan uit te gaan dat verzoeken binnen deze limieten altijd worden geaccepteerd.

Kan ik een mislukt of verlopen verzoek opnieuw proberen?

Elk voorspellingsverzoek is een nieuwe bewerking en wordt normaal gefactureerd. Een time-out of verloren antwoord bewijst niet dat er geen credits zijn afgeschreven. Controleer billing_status voordat u het opnieuw probeert; is de afschrijving niet bevestigd, neem dan contact op met support en vermeld de request_id. Herhaal bij een gedeeltelijk mislukte batch alleen de mislukte items wanneer de afschrijving is bevestigd. Respecteer bij 429 de header Retry-After.

Waar vind ik codevoorbeelden en tools voor V2?

De V2-handleidingen bevatten voorbeelden in cURL, JavaScript, Python, PHP, Java, C# en Go. Swagger en Postman gebruiken hetzelfde V2-contract. Kies het invoertype en bewaar uw API-sleutel in de serverconfiguratie.

Kan ik V1 blijven gebruiken?

Ja. Bestaande V1-integraties behouden hun endpoints en antwoordformaten. V1 en V2 gebruiken dezelfde API-sleutel en hetzelfde saldo, maar verschillen in verzoekvelden, antwoorden en fouten. Gebruik de afzonderlijke V1-documentatie om een bestaande client te onderhouden en de migratiehandleiding wanneer u naar V2 wilt overstappen.

Privacy en bestanden

Begrijpen hoe gegevens worden verwerkt

Waar u actuele informatie vindt over verwerking, bewaring en verwijdering.

Worden succesvolle GenderAPI-verzoeken bewaard?

Het privacybeleid legt uit welke verzoekgegevens, operationele gegevens en beveiligingslogs kunnen worden bewaard, voor welke doeleinden ze worden verwerkt en hoe verwijdering plaatsvindt. Controleer deze informatie voor uw integratie en verstuur geen onnodige persoonsgegevens.

Worden e-mailadressen uit verzoeken bewaard?

Het privacybeleid beschrijft hoe e-mailadressen uit verzoeken en de bijbehorende technische gegevens worden behandeld. Een e-mailadres kan een persoonsgegeven zijn: verstuur alleen wat het verzoek vereist en bewaar geen volledige adressen in uw eigen diagnostische logs.

Hoe lang worden geüploade Excel- of CSV-bestanden bewaard?

Het privacybeleid regelt de bewaring, verwijdering en back-ups van geüploade bestanden. Exporteer de resultaten die u nodig hebt en verwijder het bestand met de functies in de werkomgeving wanneer u het niet meer nodig hebt. Neem contact op met support als u vragen hebt over de bewaarvereisten van uw organisatie.

Kunnen dienstverleners verzoekgegevens of geüploade bestanden verwerken?

Het privacybeleid en de informatie over subverwerkers beschrijven hoe dienstverleners gegevens verwerken en welke beschermingsmaatregelen gelden. Bekijk deze documenten en elke overeenkomst die op uw account van toepassing is wanneer u beoordeelt waar uw gegevens worden verwerkt.

Account en ondersteuning

Koppel sleutels en beheer uw account

Gratis toegang, authenticatie, saldocontrole en ondersteuning.

Kan ik GenderAPI gratis uitproberen?

Ja. Een geregistreerd gratis account bevat 200 credits per dag. Los daarvan biedt de V2-IP-proefperiode zonder sleutel 10 credits per openbaar IP-adres per 24 uur, gedeeld met V1 en met andere gebruikers van hetzelfde IP-adres. In beide gevallen gelden de normale kosten; het aantal credits komt niet altijd overeen met het aantal HTTP-verzoeken.

Hoe authenticeer ik en bescherm ik mijn API-sleutel?

Gebruik Authorization: Bearer YOUR_API_KEY in vertrouwde servercode; POST-verzoeken vereisen daarnaast Content-Type: application/json. Houd de echte sleutel buiten browsercode, openbare repository's en logs. Ontbrekende, ongeldig opgemaakte of niet-herkende sleutels kunnen naar de IP-proefperiode leiden; controleer daarom of meta.access.mode de waarde api_key heeft. Herkende maar gedeactiveerde, verlopen of beperkte sleutels vallen niet terug op de proefperiode.

Hoe controleer ik mijn resterende credits?

Roep GET /api/v2/usage aan met uw Bearer-sleutel. Deze saldocontrole is gratis en geeft data.remaining_credits terug. Zonder sleutel wordt het gedeelde saldo van de IP-proefperiode gelezen. V1 en V2 gebruiken hetzelfde accountsaldo; de waarde remaining_credits in een voorspelling geeft het saldo aan op het moment dat de bewerking werd voltooid.

Waar kan ik mijn abonnement beheren of opzeggen?

Log in bij de GenderAPI-app om het abonnement te beheren dat aan uw API-sleutel is gekoppeld. In de huidige accountinstellingen vindt u uw pakket en de opties om op te zeggen.

Waar kan ik mijn factuurgegevens wijzigen?

Facturerings- en betaalinstellingen beheert u na het inloggen in de GenderAPI-app, per API-sleutel of abonnement.

Hoe meld ik een onjuist resultaat of krijg ik hulp bij een integratie?

Stuur support de API-versie, het endpoint, de request_id en een kort reproduceerbaar voorbeeld. Vermeld de foutcode als die er is, maar verwijder uw API-sleutel en gevoelige persoonsgegevens.

Technische kennisbank

Handleidingen voor implementatie en verantwoord gebruik

Antwoorden over resultaten, privacy en de werking van V2, met links naar de handleidingen en een Markdown-versie van elk antwoord.

01

Resultaten, betrouwbaarheid en verantwoord gebruik

02

Gegevensbronnen, privacy en naleving

Hoe worden de bronnen voor naamgegevens geselecteerd?

De pagina over de herkomst van gegevens beschrijft het kader voor het documenteren van broncategorieën, selectiecriteria, licenties en beperkingen per regio en schrift. Er is daar momenteel geen geverifieerde bronnenlijst gepubliceerd. Lees die pagina en neem contact op met support als uw integratie eisen stelt aan bronnen; ga niet uit van bronnen, datasetomvang of dekkingswaarden die niet zijn gedocumenteerd.

Lees het volledige antwoord →
Hoe vaak worden naamgegevens bijgewerkt?

De huidige pagina over de herkomst van gegevens vermeldt geen vast updateschema voor alle naamrecords of verwerkingsregels. Is de actualiteit van gegevens belangrijk voor uw toepassing, vraag support dan naar de betreffende dataset of het betreffende proces en test representatieve resultaten. De revisiedatum van een pagina betekent niet dat alle onderliggende records op die dag zijn bijgewerkt.

Lees het volledige antwoord →
Waar vind ik informatie over de AVG en de verwerkersovereenkomst?

Het privacybeleid, de AVG-informatie, de verwerkersovereenkomst en de lijst met subverwerkers beschrijven de gepubliceerde verwerkingsvoorwaarden en beschermingsmaatregelen. Bekijk de actuele documenten en elke overeenkomst die op uw account van toepassing is. Neem voor vragen die specifiek zijn voor uw organisatie, bijvoorbeeld over verwerkingsrollen, gegevensdoorgiften of verzoeken van betrokkenen, contact op met GenderAPI; een algemene FAQ vervangt de geldende overeenkomst niet.

Lees het volledige antwoord →
03

Werking van de API, fouten en afschrijvingen

Hoe authenticeer ik V2-verzoeken?

Gebruik Authorization: Bearer YOUR_API_KEY in vertrouwde servercode. POST-verzoeken van V2 vereisen daarnaast Content-Type: application/json. GET /api/v2/gender accepteert ook een sleutel als queryparameter, maar met headers komen inloggegevens niet in browser-URL's terecht. Ontbrekende, ongeldig opgemaakte of niet-herkende sleutels kunnen naar de gedeelde IP-proefperiode leiden; controleer in een integratie met een account of meta.access.mode de waarde api_key heeft. Herkende maar gedeactiveerde, verlopen of beperkte sleutels vallen niet terug op een proefperiode.

Lees het volledige antwoord →
Hoe ga ik om met verzoeklimieten en nieuwe pogingen?

V2 hanteert limieten voor het aantal verzoeken en voor gelijktijdige verzoeken; verwerk HTTP 429 en Retry-After. Elke herhaalde voorspelling is een nieuwe bewerking en wordt normaal gefactureerd. Herhaal verzoeken niet automatisch na een time-out, een verloren antwoord of een onbevestigde afschrijving. Controleer eerst code, action en meta.usage.billing_status; neem bij billing_reconciliation_required contact op met support en vermeld de request_id. Gebruik alleen een begrensde backoff wanneer de afschrijving is bevestigd en de gedocumenteerde action een nieuwe poging toestaat.

Lees het volledige antwoord →
Hoe interpreteer ik V2-fouten?

Fouten van de V2-API gebruiken HTTP-foutstatuscodes en Problem Details volgens RFC 9457, met de stabiele velden code en action. Baseer u op deze velden in plaats van de tekst van detail te vergelijken en bewaar de request_id voor support. Een succesvol onbekend resultaat is geen fout. Batchantwoorden kunnen fouten voor afzonderlijke items bevatten, ook bij HTTP 200. Een proxy kan een fout teruggeven in een ander formaat dan JSON, en een verloren of onleesbaar antwoord bewijst niet dat er geen credits zijn afgeschreven.

Lees het volledige antwoord →
Hoe controleer ik mijn resterende credits?

Roep GET /api/v2/usage aan met uw API-sleutel in de Bearer-header vanuit vertrouwde servercode. Dit verzoek is gratis en geeft data.remaining_credits terug; zonder sleutel wordt het saldo van de gedeelde IP-proefperiode gelezen. V1 en V2 gebruiken hetzelfde accountsaldo. Het veld meta.usage van een voorspelling geeft de kosten van die bewerking en het saldo op het moment van voltooiing aan, dat bij gelijktijdige verzoeken kan veranderen. Houd inloggegevens buiten logs en beschouw een saldocontrole niet als bewijs dat een bepaald verzoek met een verloren antwoord niet is gefactureerd.

Lees het volledige antwoord →
Hoe stap ik zonder onderbreking over van V1 naar V2?

Bouw nieuwe integraties op V2 en laat bestaande V1-clients hun gedocumenteerde endpoints gebruiken totdat u wilt overstappen. Beide versies gebruiken dezelfde API-sleutels en credits, maar verschillen in verzoekvelden, antwoordstructuur en foutformaat. Volg de migratiehandleiding, test succesvolle en onbekende resultaten en fouten, en pas de verwerking van antwoorden aan voordat u van endpoint wisselt. De V1-documentatie blijft beschikbaar voor bestaande integraties.

Lees het volledige antwoord →
Hoe spoor ik fouten op en bewaak ik de beschikbaarheid van de dienst?

Gebruik bij mislukte verzoeken de teruggegeven foutcode om onderscheid te maken tussen storingen, ongeldige invoer, problemen met accounttoegang, opgebruikte credits en verzoeklimieten. Bewaak in uw integratie het aandeel succesvolle verzoeken en de responstijden. Neem contact op met support en vermeld de request_id bij een onverklaarbare fout of een onduidelijke afschrijving. Baseer uitspraken over beschikbaarheid op metingen; deze FAQ noemt geen gegarandeerd beschikbaarheidspercentage.

Lees het volledige antwoord →

Nog hulp nodig?

Stuur ons een reproduceerbaar voorbeeld

Vermeld het endpoint, de verzoekparameters en de teruggegeven fout, maar stuur geen productie-API-sleutel of gevoelige persoonsgegevens mee.