DOKUMENTACJA API

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Zapytanie po adresie e‑mail (v2)
PURPOSE: Wyodrębnij imiona z adresów e‑mail i określ płeć dzięki zaawansowanym algorytmom parsującym.

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

--- AUTHENTICATION ---
Header: Content-Type: application/json
Header: Authorization: Bearer <Twój token autoryzacyjny> 
link

--- REQUEST PARAMETERS ---

Parameter: email
  Type: string
  Required: REQUIRED
  Description: Adres e-mail do sprawdzenia

Parameter: country
  Type: string
  Required: OPTIONAL
  Description: Kod kraju ISO 3166 ALPHA-2 link

Parameter: locale
  Type: string
  Required: OPTIONAL
  Description: Ustawienia regionalne przeglądarki

Parameter: ip
  Type: string
  Required: OPTIONAL
  Description: Poprawny adres IPv4 lub IPv6

Parameter: id
  Type: string
  Required: OPTIONAL
  Description: Maksymalnie 50 znaków. Id możesz ustawić na dowolną wartość alfanumeryczną.
Możesz na przykład wpisać tu swój wewnętrzny identyfikator zbioru danych w bazie. W środowisku asynchronicznym pomoże Ci to lepiej powiązać odpowiedź z wcześniejszym żądaniem

--- REQUEST EXAMPLES ---

Example 1: Zapytanie tylko po adresie e-mail
Request Body (JSON):
{
    "email": "theresa.miller14@gmail.com"
}

Example 2: Zapytanie po adresie e-mail i kodzie kraju
Request Body (JSON):
{
    "email": "thomas.clarks@hotmail.com",
    "country": "US"
}

Example 3: Zapytanie po adresie e-mail i ustawieniach regionalnych przeglądarki
Request Body (JSON):
{
    "email": "Thomas.j32@live.com",
    "locale": "en_US"
}

Example 4: Zapytanie po adresie e-mail z użyciem adresu IP do lokalizacji
Request Body (JSON):
{
    "email": "thomasfromnewyork@gmail.com",
    "ip": "54.201.16.177"
}

Example 5: Zapytanie o wiele imion w jednym żądaniu
Request Body (JSON):
[
    {
        "email": "thomas.clarks@hotmail.com",
        "country": "US"
    },
    {
        "email": "theresa.miller14@gmail.com"
    }
]

--- EXPECTED RESPONSE ---

Response (JSON):
{
    "input": {
        "email": "theresa.miller14@gmail.com"
    },
    "details": {
        "credits_used": 1,
        "duration": "12ms",
        "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: Wysłany payload

Field: details.credits_used
  Type: int
  Description: Liczba żądań wykorzystanych na to zapytanie

Field: details.samples
  Type: int
  Description: Liczba rekordów w naszej bazie danych, które pasują do Twojego żądania

Field: details.country
  Type: string
  Description: Znaleziony przez nas kraj

Field: details.email_sanitized
  Type: int
  Description: Imię po zastosowaniu normalizacji

Field: details.duration
  Type: string
  Description: Czas, jakiego serwer potrzebował na przetworzenie żądania

Field: result_found
  Type: bool
  Description: true, jeśli udało nam się ustalić płeć dla podanego imienia

Field: email
  Type: string
  Description: Adres e-mail użyty do określenia płci

Field: probability
  Type: float
  Description: Ta wartość (od 0 do 1) określa wiarygodność naszej bazy danych. Wartość 1 oznacza, że wynik Twojego żądania o płeć jest w 100% dokładny.

Field: gender
  Type: string
  Description: Możliwe wartości: 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 <Twój token autoryzacyjny> link' \
  -d '{"email":"theresa.miller14@gmail.com"}'

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

=== END OF INSTRUCTIONS ===