DOKUMENTACJA API

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: Zarejestruj się (v2)
PURPOSE: Załóż darmowe konto i otrzymaj hasło do logowania oraz token API. Bez konieczności uwierzytelniania.

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

--- AUTHENTICATION ---
Header: Content-Type: application/json

--- REQUEST PARAMETERS ---

Parameter: email
  Type: string
  Required: REQUIRED
  Description: Adres e-mail do rejestracji. Imię ani nazwisko nie są wymagane.

Parameter: accept_terms
  Type: bool
  Required: REQUIRED
  Description: Musi mieć wartość true. Użytkownik musi zaakceptować Regulamin oraz Politykę prywatności.

Parameter: newsletter
  Type: bool
  Required: OPTIONAL
  Description: Zapis do newslettera. Domyślnie false.

Parameter: locale
  Type: string
  Required: OPTIONAL
  Description: Język konta. Jeden z: en, de, es. Domyślnie: en.

--- REQUEST EXAMPLES ---

Example 1: Zarejestruj się za pomocą adresu e-mail
Request Body (JSON):
{
    "email": "user@example.com",
    "accept_terms": true
}

Example 2: Zarejestruj się i zasubskrybuj newsletter
Request Body (JSON):
{
    "email": "user@example.com",
    "accept_terms": true,
    "newsletter": true,
    "locale": "en"
}

--- EXPECTED RESPONSE ---

Response (JSON):
{
    "email": "user@example.com",
    "password": "",
    "api_token": "",
    "free_requests_per_month": 100,
    "status": "awaiting_activation",
    "message": "Account created. Ask the user to click the activation link sent to their email address. The API token below activates automatically once the email is confirmed and can then be used as a Bearer token against the API.",
    "docs_url": "https://gender-api.com/skill.md"
}

--- RESPONSE FIELDS ---

Field: email
  Type: string
  Description: Zarejestrowany adres e-mail.

Field: password
  Type: string
  Description: Losowe hasło logowania do panelu w przeglądarce. Zostanie zwrócone tylko raz — zapisz je w bezpiecznym miejscu. Użytkownik może później zresetować je przez procedurę „nie pamiętam hasła”.

Field: api_token
  Type: string
  Description: Token bearer do API. Użyj go jako „Authorization: Bearer ” w żądaniach /v2/…. Zacznie działać, gdy użytkownik potwierdzi swój adres e-mail.

Field: free_requests_per_month
  Type: int
  Description: Liczba bezpłatnych żądań przyznawanych na miesiąc.

Field: status
  Type: string
  Description: Status konta. „awaiting_activation”, dopóki adres e-mail nie zostanie potwierdzony.

Field: message
  Type: string
  Description: Czytelna wskazówka, co zrobić dalej (potwierdzić adres e-mail).

Field: docs_url
  Type: string
  Description: Link do gotowych do użycia instrukcji wdrożenia AI (skill.md).

--- 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/sign-up' \
  -H 'Content-Type: application/json' \
  -d '{"email":"user@example.com","accept_terms":true}'

--- CREDIT USAGE ---
Required Requests: 0

=== END OF INSTRUCTIONS ===