APIドキュメント

=== AI IMPLEMENTATION INSTRUCTIONS ===

ENDPOINT: 新規登録（v2）
PURPOSE: 無料アカウントを作成すると、ログイン用パスワードとAPIトークンを受け取れるよ。認証は不要です。

--- 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: 登録に使うメールアドレス。名も姓も入力する必要はありません。

Parameter: accept_terms
  Type: bool
  Required: REQUIRED
  Description: true である必要があります。ユーザーは 利用規約 とプライバシーポリシーに同意する必要があります。

Parameter: newsletter
  Type: bool
  Required: OPTIONAL
  Description: ニュースレターを購読する。デフォルトは false。

Parameter: locale
  Type: string
  Required: OPTIONAL
  Description: アカウントの言語。「en」「de」「es」のいずれか。指定がない場合は「en」がデフォルトです。

--- REQUEST EXAMPLES ---

Example 1: メールアドレスで登録する
Request Body (JSON):
{
    "email": "user@example.com",
    "accept_terms": true
}

Example 2: 登録してニュースレターを購読しよう
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: 登録済みのメールアドレス。

Field: password
  Type: string
  Description: ウェブダッシュボード用のランダムなログインパスワード。返されるのは1回だけなので、安全な場所に保管してね。あとで「パスワードを忘れた」からリセットできるよ。

Field: api_token
  Type: string
  Description: APIのBearerトークン。「Authorization: Bearer 」として /v2/... リクエストで使ってね。ユーザーがメールアドレスを確認すると利用できるようになるよ。

Field: free_requests_per_month
  Type: int
  Description: 毎月付与される無料リクエスト数。

Field: status
  Type: string
  Description: アカウントのステータス。「awaiting_activation」は、メールアドレスの確認が完了するまで表示されます。

Field: message
  Type: string
  Description: 次のステップ（メールアドレスの確認）についての、わかりやすい案内文。

Field: docs_url
  Type: string
  Description: すぐ使える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 ===