API दस्तावेज़

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: ईमेल पते द्वारा क्वेरी करो (v2)
PURPOSE: उन्नत पार्सिंग एल्गोरिदम के साथ ईमेल पतों से नाम निकालो और लिंग निर्धारित करो।

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

--- AUTHENTICATION ---
Header: Content-Type: application/json
Header: Authorization: Bearer <तुम्हारा प्राधिकरण टोकन> 
link

--- REQUEST PARAMETERS ---

Parameter: email
  Type: string
  Required: REQUIRED
  Description: क्वेरी करने के लिए ईमेल पता

Parameter: country
  Type: string
  Required: OPTIONAL
  Description: ISO 3166 ALPHA-2 देश कोड link

Parameter: locale
  Type: string
  Required: OPTIONAL
  Description: ब्राउज़र लोकेल

Parameter: ip
  Type: string
  Required: OPTIONAL
  Description: मान्य IPv4 या IPv6 पता

Parameter: id
  Type: string
  Required: OPTIONAL
  Description: अधिकतम 50 वर्ण। तुम इस आईडी को किसी भी अक्षरांकीय मान पर सेट कर सकते हो जो तुम चाहते हो।
उदाहरण के लिए, तुम आईडी को अपने डेटाबेस में अपने आंतरिक आईडी पर सेट कर सकते हो। एक असतत
वातावरण में यह रिस्पॉन्स को पिछले अनुरोध से बेहतर ढंग से जोड़ने में तुम्हारी मदद कर सकता है

--- REQUEST EXAMPLES ---

Example 1: केवल ईमेल पते से क्वेरी करो
Request Body (JSON):
{
    "email": "theresa.miller14@gmail.com"
}

Example 2: ईमेल पते और देश कोड द्वारा क्वेरी करो
Request Body (JSON):
{
    "email": "thomas.clarks@hotmail.com",
    "country": "US"
}

Example 3: ईमेल पते और ब्राउज़र लोकेल द्वारा क्वेरी करो
Request Body (JSON):
{
    "email": "Thomas.j32@live.com",
    "locale": "en_US"
}

Example 4: ईमेल पते द्वारा क्वेरी करो और स्थानीयकरण के लिए IP ​​पते का उपयोग करो
Request Body (JSON):
{
    "email": "thomasfromnewyork@gmail.com",
    "ip": "54.201.16.177"
}

Example 5: एक ही अनुरोध में कई नामों की क्वेरी करो
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: प्रस्तुत पेलोड

Field: details.credits_used
  Type: int
  Description: इस क्वेरी के लिए इस्तेमाल हुए अनुरोधों की संख्या

Field: details.samples
  Type: int
  Description: हमारे डेटाबेस में पाए गए रिकॉर्ड की संख्या जो तुम्हारे अनुरोध से मेल खाती है

Field: details.country
  Type: string
  Description: देश जो हमें मिला

Field: details.email_sanitized
  Type: int
  Description: हमारा नॉर्मलाइज़र लगाने के बाद का नाम

Field: details.duration
  Type: string
  Description: सर्वर को अनुरोध संसाधित करने के लिए आवश्यक समय

Field: result_found
  Type: bool
  Description: दिए गए नाम का लिंग हम खोज पाए तो true

Field: email
  Type: string
  Description: हमने लिंगीकरण के लिए उपयोग किया ईमेल पता

Field: probability
  Type: float
  Description: यह मान (0 और 1 के बीच) हमारे डेटाबेस की विश्वसनीयता निर्धारित करता है। 1 का मान इंगित करता है कि तुम्हारे लिंग अनुरोध पर परिणाम 100% सटीक हैं।

Field: gender
  Type: string
  Description: संभावित मान: 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 <तुम्हारा प्राधिकरण टोकन> link' \
  -d '{"email":"theresa.miller14@gmail.com"}'

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

=== END OF INSTRUCTIONS ===