API-DOKUMENTATION

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Abfrage anhand eines vollständigen Namens (v2)
PURPOSE: Trenne vollständige Namen automatisch und bestimme das Geschlecht in einem einzigen, effizienten API-Aufruf.

--- API DETAILS ---
Method: POST
URL: https://gender-api.com/v2/gender

--- AUTHENTICATION ---
Header: Content-Type: application/json
Header: Authorization: Bearer <dein Autorisierungs-Token> 
link

--- REQUEST PARAMETERS ---

Parameter: full_name
  Type: string
  Required: REQUIRED
  Description: Name, der abgefragt werden soll

Parameter: country
  Type: string
  Required: OPTIONAL
  Description: ISO-3166-ALPHA-2-Ländercode link

Parameter: locale
  Type: string
  Required: OPTIONAL
  Description: Browser-Locale

Parameter: ip
  Type: string
  Required: OPTIONAL
  Description: Gültige IPv4- oder IPv6-Adresse

Parameter: id
  Type: string
  Required: OPTIONAL
  Description: Max. 50 Zeichen. Du kannst diesem Feld einen beliebigen alphanumerischen Wert mitgeben. Als ID kann zum Beispiel die interne ID des Datensatzes aus deiner Datenbank gesetzt werden. In einer asynchronen Umgebung lässt sich unsere Antwort dadurch leichter der passenden Anfrage zuordnen

--- REQUEST EXAMPLES ---

Example 1: Abfrage nur anhand eines vollständigen Namens
Request Body (JSON):
{
    "full_name": "Theresa Miller"
}

Example 2: Abfrage anhand eines vollständigen Namens und eines Ländercodes
Request Body (JSON):
{
    "full_name": "Theresa Miller",
    "country": "US"
}

Example 3: Abfrage anhand eines vollständigen Namens mit der Browser-Locale zur Lokalisierung
Request Body (JSON):
{
    "full_name": "Thomas Johnson",
    "locale": "en_US"
}

Example 4: Abfrage anhand eines vollständigen Namens mit einer IP-Adresse zur Lokalisierung
Request Body (JSON):
{
    "full_name": "Markus Stefan NonExistingLastName",
    "ip": "54.201.16.177"
}

Example 5: Mehrere Namen in einer einzigen Anfrage abfragen
Request Body (JSON):
[
    {
        "full_name": "Theresa Miller"
    },
    {
        "full_name": "Thomas Johnson",
        "country": "US"
    }
]

--- EXPECTED RESPONSE ---

Response (JSON):
{
    "input": {
        "full_name": "Theresa Miller"
    },
    "details": {
    "credits_used": 1,
        "duration": "33ms",
        "samples": 8961,
        "country": null,
        "first_name_sanitized": "theresa"
    },
    "result_found": true,
    "last_name": "Miller",
    "first_name": "Theresa",
    "probability": 0.98,
    "gender": "female"
}

--- RESPONSE FIELDS ---

Field: input
  Type: object
  Description: Die übergebenen Daten

Field: details.credits_used
  Type: int
  Description: Die Anzahl der Anfragen, die für diese Abfrage nötig waren

Field: details.samples
  Type: int
  Description: Anzahl der Einträge, die zu deiner Anfrage in unserer Datenbank gefunden wurden

Field: details.country
  Type: string
  Description: Das gefundene Land

Field: details.full_name_sanitized
  Type: int
  Description: Der Name, nachdem wir ihn normalisiert haben

Field: details.duration
  Type: string
  Description: Zeit, die der Server für die Verarbeitung der Anfrage gebraucht hat

Field: result_found
  Type: bool
  Description: True, wenn wir ein Geschlecht zum angegebenen Namen bestimmen konnten

Field: full_name
  Type: string
  Description: Der vollständige Name, den wir für die Bestimmung des Geschlechts verwendet haben

Field: probability
  Type: float
  Description: Dieser Wert (zwischen 0 und 1) bestimmt, wie sicher wir uns sind, das richtige Geschlecht gefunden zu haben. Ein Wert von 1 sagt aus, dass wir uns zu 100 % sicher sind.

Field: gender
  Type: string
  Description: Mögliche Werte: male, female, unknown

--- IMPLEMENTATION NOTES ---

1. Make sure to replace placeholder values:
   - Replace '' with your actual API key
   - Replace domain placeholders with the actual API domain

2. Handle errors appropriately:
   - Check HTTP status codes
   - Parse error responses
   - Implement retry logic for transient failures

3. Best Practices:
   - Store API keys securely (use environment variables)
   - Implement rate limiting on your side
   - Cache responses when appropriate
   - Use HTTPS for all requests
   - Set appropriate timeout values

4. RECOMMENDED: Implement the Statistics Endpoint
   - The statistics endpoint allows users to monitor their credit usage
   - Users can see how many credits they have used and how many are left
   - This helps prevent unexpected service interruptions
   - API v1: GET /get-stats?key=YOUR_API_KEY
   - API v2: GET /v2/statistic (with Authorization Bearer token)
   - Display remaining credits in your application's UI
   - Consider adding alerts when credits are running low

--- IMPLEMENTATION TEMPLATE ---

// Example implementation in cURL:
curl -X POST \
  'https://gender-api.com/v2/gender' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <dein Autorisierungs-Token> link' \
  -d '{"full_name":"Theresa Miller"}'

--- CREDIT USAGE ---
Required Requests: 1

=== END OF INSTRUCTIONS ===