API दस्तावेज़

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: आँकड़े लो (v2)
PURPOSE: तुम्हारे खाते के लिए विस्तृत उपयोग आँकड़े और शेष अनुरोध क्रेडिट प्राप्त करो।

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

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

--- EXPECTED RESPONSE ---

Response (JSON):
{
    "is_limit_reached": false,
    "remaining_credits": 24999,
    "details": {
        "credits_used": 0,
        "duration": "83ms"
    },
    "usage_last_month": {
        "date": "2018-03",
        "credits_used": 25
    }
}

--- RESPONSE FIELDS ---

Field: is_limit_reached
  Type: bool
  Description: यदि कोई और अनुरोध शेष नहीं है तो true लौटाता है

Field: remaining_credits
  Type: int
  Description: बाकी अनुरोधों की संख्या

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

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

Field: usage_last_month.date
  Type: string
  Description: पिछले महीने की तिथि

Field: usage_last_month.credits_used
  Type: int
  Description: पिछले महीने में तुम्हारे द्वारा उपयोग किए गए अनुरोध

--- 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 GET \
  'https://gender-api.com/v2/statistic' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <तुम्हारा प्राधिकरण टोकन> link' \

=== END OF INSTRUCTIONS ===