Was verrät eine E-Mail-Adresse?
Senden Sie eine syntaktisch gültige E-Mail-Adresse mit type: email. GenderAPI.io sucht im Teil vor dem @ nach einem Namenshinweis und liefert dann eine strukturierte Vorhersage. Das Postfach wird dabei weder verifiziert noch einem Inhaber zugeordnet, und die Geschlechtsidentität dieser Person wird nicht festgestellt.
Der Abgleich mit dem Datensatz leitet Kandidaten aus Bestandteilen ab und kann begrenzte Teilstrings prüfen. Der Spitznamenmodus behält den Abgleich ganzer Bestandteile bei, fügt aber keine solchen Teilstring-Kandidaten hinzu. Passen mehrere Einträge, wird der Kandidat mit der größten gespeicherten Gesamtzahl ausgewählt; das muss nicht der gemeinte Vorname sein. Prüfen Sie data.name und data.match, bevor Sie einen extrahierten Namen in einem Kontaktdatensatz verwenden.
| Beispieleingabe | Einordnung |
|---|---|
alice.smith@example.com | Der lokale Teil enthält mögliche Namensbestandteile. Ein Treffer ist möglich, doch die Eingabe allein legt nicht fest, welcher Kandidat ausgewählt wird. |
alice+news@example.com | Die Datensatzabfrage entfernt für ihre Kandidaten den Zusatz nach dem Pluszeichen. Die KI wird angewiesen, ihn zu ignorieren, erhält aber den übermittelten Wert. |
support@example.com | Eine Funktionsadresse liefert keinen verlässlichen Hinweis auf einen Personennamen. Weisen Sie dem gesamten gemeinsamen Postfach nicht das Geschlecht einer Person zu. |
prenses@example.com | Das optionale forceToGenderize erlaubt einen Versuch anhand der Bedeutung eines Spitznamens, wenn der Datensatz kein Ergebnis liefert. Ein echter Name ist in diesem Modus nicht erforderlich. |
not-an-email | Eine ungültige Syntax liefert einen Validierungsfehler statt eines erfolgreichen unbekannten Ergebnisses. |
Eine E-Mail-Abfrage aus Ihrer Anwendung senden
Dieses Beispiel verwendet Ihren vorhandenen API-Schlüssel im Bearer-Header und setzt fallback ausdrücklich. Ersetzen Sie die Beispieladresse durch eine Eingabe, die Sie verarbeiten dürfen. Geben Sie country nur an, wenn Sie relevanten Kontext haben; die E-Mail-Domain belegt nicht den Aufenthaltsort einer Person. Ohne Länderkontext lassen Sie dieses Feld weg.
Führen Sie das Beispiel auf Ihrem Server aus, nachdem Sie GENDERAPI_API_KEY gesetzt haben. POST hält die E-Mail-Adresse aus der Anfrage-URL heraus. Das Live-Ergebnis kann von der beispielhaften Antwort in der Demo abweichen.
Wählen Sie eine Programmiersprache. Richten Sie Ihren API-Schlüssel ein, und führen Sie dann das Beispiel auf Ihrem Server aus.
Jede Vorhersageanfrage ist ein neuer kostenpflichtiger Vorgang, auch bei Wiederholungen. Diese Beispiele wiederholen Anfragen nicht automatisch. Prüfen Sie den Abrechnungsstatus, bevor Sie eine weitere Anfrage senden.
Vor der Ausführung: Zugang und Fehlerbehandlung
Führen Sie diese Beispiele auf Ihrem Server aus. Setzen Sie GENDERAPI_API_KEY in der Prozessumgebung auf Ihren vorhandenen API-Schlüssel. Prüfen Sie, ob meta.access.mode den Wert api_key hat: Ein nicht erkannter Schlüssel kann in den IP-Testzugang wechseln.
Bei HTTP-4xx- und -5xx-Antworten im JSON-Format bleibt der Fehlerinhalt erhalten, und das Beispiel endet mit einem Exit-Status ungleich null. Prüfen Sie code, action und meta.usage.billing_status, bevor Sie die Anfrage wiederholen.
Anleitung zu Fehlern und Wiederholungen →cURL 7.76+ in einer POSIX-Shell. Im Terminal ausführen. Dokumentation der Laufzeitumgebung
Node.js 22+; integriertes fetch. Als example.mjs speichern und node example.mjs ausführen. Dokumentation der Laufzeitumgebung
Python 3.10+; Standardbibliothek. Als example.py speichern und python3 example.py ausführen. Dokumentation der Laufzeitumgebung
PHP 8+ mit der cURL-Erweiterung. Als example.php speichern und php example.php ausführen. Dokumentation der Laufzeitumgebung
Java 17+; Standard-HTTP-Client. Als GenderApiExample.java speichern und java GenderApiExample.java ausführen. Dokumentation der Laufzeitumgebung
Konsolenanwendung mit .NET 8+. Als Program.cs in einem Konsolenprojekt verwenden und dann dotnet run ausführen. Dokumentation der Laufzeitumgebung
Go 1.22+; Standardbibliothek. Als main.go speichern und go run main.go ausführen. Dokumentation der Laufzeitumgebung
Ergebnis und Belege gemeinsam aufbewahren
Eine abgeleitete Zuordnung ist nicht das Geschlecht, das eine Person selbst angibt. Bewahren Sie die ursprüngliche Eingabe, die zurückgegebenen Belege und alle Angaben der Person selbst getrennt auf. Ein unbekanntes Ergebnis ist ein gültiges Ergebnis; es sollte in Ihrer Anwendung nicht zu einer geratenen Kategorie werden.
| Feld | Verwendung |
|---|---|
data.gender / data.result_status | Verwenden Sie male oder female nur bei identified. Behalten Sie bei einem unbekannten Ergebnis den nativen JSON-Wert null bei. |
data.name / data.match | Prüfen Sie den zurückgegebenen Namen und den ausgewählten Kandidaten. Ein Treffer über einen Teilstring belegt nicht, dass die Eingabe zu einer Person mit diesem Vornamen gehört. |
data.confidence / data.confidence_kind | Die Konfidenz liegt auf einer Skala von 0–1 oder ist null. observed_frequency beruht auf gespeicherten Häufigkeiten; model_reported ist ein KI-Wert. Bewerten Sie Schwellenwerte für jede Art getrennt. |
data.source / data.sample_count | Unterscheiden Sie dataset, ai und none. KI-Ergebnisse haben keine gespeicherte Stichprobengröße. Eine Stichprobengröße ist kein gemessener Genauigkeitswert. |
meta.access.mode | Prüfen Sie bei einer Kontointegration, ob api_key gemeldet wird. Fehlende oder nicht erkannte Schlüssel können stattdessen den gemeinsamen IP-Testzugang nutzen. |
meta.usage | Lesen Sie charged_credits und billing_status. Ein erfolgreiches unbekanntes Ergebnis ist kostenpflichtig. Eine verlorene Antwort belegt nicht, dass die Anfrage kostenlos war. |
Festlegen, wann KI eingesetzt wird
forceToGenderize ist für Namen, E-Mail-Adressen und Benutzernamen optional. Ist es aktiviert, lassen Sie ai_mode weg oder verwenden Sie fallback; off und always sind damit unvereinbar und liefern 422. Ein positives Anfangsguthaben genügt, um eine Anfrage zu starten, auch wenn die endgültige Abbuchung das Guthaben unter null senkt.
Der Spitznamenmodus kann ein Geschlecht zusammen mit name: null zurückgeben. Er kann auch ein unbekanntes Ergebnis liefern. Weder der gewöhnliche KI-Fallback noch die Spitznamen-Auswertung garantieren eine richtige Antwort oder einen Wert ungleich null.
| Anfrageoption | Verhalten | Credits für eine erfolgreiche Abfrage |
|---|---|---|
| options.ai_mode: off | Nur den Datensatz verwenden. | 1, auch bei einem unbekannten Ergebnis |
| options.ai_mode: fallback | Zuerst den Datensatz prüfen, dann gewöhnliche KI, wenn kein Geschlecht zurückgegeben wird. Das ist der Standard für Einzelanfragen. | Insgesamt 1, einschließlich KI-Fallback |
| options.ai_mode: always | Direkt KI verwenden. | 2 |
| forceToGenderize: true | Zuerst den Datensatz prüfen, dann KI einen persönlichen Spitznamen oder Alias auswerten lassen, auch ohne echten Vornamen. | 1 für ein im Datensatz aufgelöstes Ergebnis; insgesamt 2, wenn KI eingesetzt wird |
Eine E-Mail-Liste in Batches verarbeiten
Verwenden Sie POST /api/v2/gender/batch mit einem items-Array aus Einträgen mit type: email. Der Zugang mit registriertem API-Schlüssel unterstützt bis zu 50 Einträge, der IP-Testzugang bis zu 10. Behalten Sie für jeden Eintrag eine eindeutige id, damit Sie die Ergebnisse der ursprünglichen Zeile zuordnen können. Die Antwort behält außerdem die Eingabereihenfolge bei und meldet index.
Batch-Einträge nutzen standardmäßig nur den Datensatz. Setzen Sie options.ai_mode: fallback bei jedem Eintrag, der den gewöhnlichen KI-Fallback benötigt. Zwei erfolgreiche Einträge mit fallback kosten insgesamt 2 Credits, auch bei unbekannten Ergebnissen; eine HTTP-Anfrage entspricht nicht einem Credit pro Vorhersage.
Prüfen Sie jeden Eintrag, auch wenn der Batch HTTP 200 zurückgibt. Speichern Sie erfolgreiche und unbekannte Ergebnisse und prüfen Sie dann Fehler und die bestätigte Abrechnung, bevor Sie fehlgeschlagene Einträge erneut senden. Senden Sie nach einer Zeitüberschreitung keinen erfolgreichen Batch vollständig erneut, ohne das Abrechnungsergebnis zu prüfen.
Wissen, was Sie senden
Die Live-Demo sendet den eingegebenen Wert erst dann an GenderAPI.io, wenn Sie ihn absenden. Wird KI eingesetzt, gehen der übermittelte type, der value und der Länderkontext an den konfigurierten Inferenzdienst. Für eine Vorhersage nur mit dem Datensatz verwenden Sie in Ihrer Integration options.ai_mode: off ohne forceToGenderize.
Die Datenschutzerklärung, der Auftragsverarbeitungsvertrag und das Verzeichnis der Unterauftragsverarbeiter beschreiben die veröffentlichten Verarbeitungsbedingungen. Ein Ergebnis ist eine abgeleitete Zuordnung; Angaben der Person selbst haben Vorrang. Nutzen Sie es nicht als Grundlage für folgenreiche Entscheidungen über eine Person.
Häufig gestellte Fragen
Kann die API einen Vornamen aus einer E-Mail-Adresse extrahieren?
Sie kann einen Namenskandidaten zurückgeben, wenn der lokale Teil einen verwertbaren Hinweis enthält. Treffer über ganze Bestandteile und über Teilstrings sind möglich; prüfen Sie daher data.match. Das Ergebnis belegt nicht den Vornamen der Person, der das Postfach gehört.
Liefern info@ oder support@ ein Geschlecht?
Gemeinsam genutzte Funktionsadressen liefern in der Regel keinen Beleg für einen Personennamen. Ein unbekanntes Ergebnis ist gültig. KI oder der Spitznamenmodus sollten nicht als Bestätigung für die Personen gelten, die ein gemeinsames Postfach nutzen.
Verbraucht ein unbekanntes Ergebnis für eine E-Mail-Adresse Credits?
Ja. Eine erfolgreiche gewöhnliche E-Mail-Abfrage kostet 1 Credit, einschließlich KI-Fallback und unbekannter Ergebnisse. Die erzwungene Spitznamen-Auswertung kostet 1 Credit für ein im Datensatz aufgelöstes Ergebnis oder insgesamt 2, wenn KI eingesetzt wird. Für Fehler wird das Abrechnungsergebnis separat in meta.usage gemeldet.
Wird die E-Mail-Domain vor der Verarbeitung durch die KI entfernt?
Eine solche Entfernung wird nicht zugesagt. Kandidaten aus dem Datensatz stammen aus dem lokalen Teil, während die KI den übermittelten Wert erhält und angewiesen wird, die Domain und den Zusatz nach dem Pluszeichen zu ignorieren. Verwenden Sie den Modus nur mit dem Datensatz, wenn Ihr Ablauf das erfordert.