أسماء الدفعات ورسائل البريد الإلكتروني وأسماء المستخدمين
يقبل POST /gender/batch مصفوفة items التي تحتوي على 1–50 إدخالاً مع الوصول إلى مفتاح واجهة برمجة التطبيقات (API)، أو 10 إدخالات على الأكثر مع تجربة IP. أرسل الأسماء أو عناوين البريد الإلكتروني أو أسماء المستخدمين أو مزيجًا من الثلاثة. يحتوي كل إدخال على حقول country وforceToGenderize وoptions منفصلة. المعرفات اختيارية ولكن يجب أن تكون فريدة ضمن الدفعة.
تتبع النتائج ترتيب الإدخال. تحتوي كل نتيجة على index وcharged_credits وواحدة بالضبط من data أو error. إذا قمت بتوفير id، فسيتم إرجاعه أيضًا. يمكن أن تحتوي استجابة HTTP 200 على حالات فشل للإدخالات الفردية، لذا تحقق من كل نتيجة. يتضمن meta.summary total، وsucceeded، وidentified، وunknown، وfailed. لا يزال التنبؤ المكتمل بدون جنس معروف يعتبر ناجحًا ويكلف أرصدة.
إذا فشل التحقق من صحة الطلب أو التخطيط، فسيتم رفض الدفعة بأكملها قبل خصم أي اعتمادات. إذا فشلت كافة الإدخالات أثناء التنفيذ، تقوم واجهة برمجة التطبيقات (API) بإرجاع استجابة مشكلة غير 2xx بمصفوفة data والاسم المستعار القديم results. تكلف الإدخالات الفاشلة صفر أرصدة بعد تأكيد استرداد الأموال. إذا كانت الفواتير غير مؤكدة، فلا تفترض أن التكلفة المبلغ عنها لكل إدخال نهائية.
اختر لغة البرمجة. قم بإعداد مفتاح API الخاص بك, ثم قم بتشغيل المثال على الخادم الخاص بك.
كل طلب تنبؤ هو عملية جديدة قابلة للفوترة، بما في ذلك إعادة المحاولة. لا تقوم هذه الأمثلة بإعادة المحاولة تلقائيًا. التحقق من حالة الفواتير قبل إرسال طلب آخر.
قبل التشغيل: الوصول ومعالجة الأخطاء
قم بتشغيل هذه الأمثلة على الخادم الخاص بك. قم بتعيين GENDERAPI_API_KEY في بيئة العملية على مفتاح API الموجود لديك. تأكد من أن meta.access.mode هو api_key: يمكن أن يعود المفتاح غير المعروف إلى النسخة التجريبية من IP.
بالنسبة لاستجابات HTTP 4xx و5xx JSON، تحافظ الأمثلة على نص الخطأ وتخرج بحالة غير صفرية. تحقق من code وaction وmeta.usage.billing_status قبل إعادة المحاولة. للحصول على استجابة دفعة HTTP 200، قم أيضًا بفحص data أو error في كل نتيجة.
دليل الخطأ وإعادة المحاولة →cURL 7.76+ في غلاف POSIX. قم بالتشغيل في جهازك الطرفي. وثائق وقت التشغيل
Node.js 22+; جلب مدمج. احفظ باسم example.mjs وقم بتشغيل node example.mjs. وثائق وقت التشغيل
Python 3.10+; مكتبة قياسية. احفظ باسم example.py وقم بتشغيل python3 example.py. وثائق وقت التشغيل
PHP 8+ مع الامتداد cURL. احفظ باسم example.php وقم بتشغيل php example.php. وثائق وقت التشغيل
Java 17+; عميل HTTP القياسي. احفظ باسم GenderApiExample.java وقم بتشغيل java GenderApiExample.java. وثائق وقت التشغيل
تطبيق وحدة التحكم .NET 8+. استخدمه كـ Program.cs في مشروع وحدة التحكم، ثم قم بتشغيل dotnet run. وثائق وقت التشغيل
Go 1.22+; مكتبة قياسية. احفظ باسم main.go وقم بتشغيل go run main.go. وثائق وقت التشغيل
اقرأ الرد الدفعي
يحتوي هذا المثال الاصطناعي المستقل على تطابق مجموعة بيانات، ونتيجة غير معروفة، وفشل الموفر. وهو يوضح استجابة HTTP 200 للنجاح الجزئي، وليس الإخراج المتوقع للطلب الدفعي أعلاه. العنصران الناجحان يكلفان رصيدًا واحدًا لكل منهما؛ العنصر الفاشل له رسوم مؤكدة صفر.
{
"data": [
{
"index": 0,
"id": "known",
"charged_credits": 1,
"data": {
"input": {
"type": "name",
"value": "Onur",
"country": "TR"
},
"name": "onur",
"gender": "male",
"country": "TR",
"confidence": 0.9,
"confidence_kind": "observed_frequency",
"sample_count": 100,
"source": "dataset",
"result_status": "identified",
"reason": null,
"country_source": "dataset",
"match": {
"name": "onur",
"method": "normalized",
"scope": "country",
"country": "TR"
}
}
},
{
"index": 1,
"id": "missing",
"charged_credits": 1,
"data": {
"input": {
"type": "name",
"value": "zzzxxyy",
"country": null
},
"name": null,
"gender": null,
"country": null,
"confidence": null,
"confidence_kind": null,
"sample_count": null,
"source": "none",
"result_status": "unknown",
"reason": "not_found",
"country_source": null,
"match": {
"name": null,
"method": null,
"scope": null,
"country": null
}
}
},
{
"index": 2,
"id": "failed",
"charged_credits": 0,
"error": {
"type": "urn:genderapi:problem:ai_upstream_error",
"title": "ai upstream error",
"status": 502,
"detail": "The AI provider could not complete the request.",
"instance": "urn:uuid:11111111-1111-4111-8111-111111111111",
"code": "ai_upstream_error",
"request_id": "11111111-1111-4111-8111-111111111111",
"documentation": "https://api.genderapi.io/api/v2/errors",
"action": "inspect_billing_before_retry"
}
}
],
"meta": {
"request_id": "11111111-1111-4111-8111-111111111111",
"duration_ms": 12,
"access": {
"mode": "ip_trial",
"reason": "api_key_missing"
},
"usage": {
"charged_credits": 2,
"remaining_credits": 6,
"billing_status": "confirmed",
"resets_at": "2026-09-26T12:00:00.000Z",
"limit": 10,
"period_seconds": 86400
},
"summary": {
"total": 3,
"succeeded": 2,
"identified": 1,
"unknown": 1,
"failed": 1
}
}
}تخطيط الاعتمادات المجمعة وإعادة المحاولة
قم بالمصادقة باستخدام مفتاح Bearer API الموجود لديك وأرسل Content-Type: application/json. كل دفعة مقدمة هي عملية جديدة. في حالة فشل إعادة المحاولة جزئيًا، قم بإرسال العناصر الفاشلة فقط بعد التحقق من الفواتير؛ إعادة إرسال العناصر الناجحة يشحنها مرة أخرى.
تستخدم عناصر الطلب المجمّع off افتراضيًا وتستهلك وحدة واحدة لكل توقع مكتمل. يستهلك fallback أيضًا وحدة واحدة إجمالًا، بما في ذلك الذكاء الاصطناعي، بينما يستهلك always وحدتين. مع forceToGenderize، تكون التكلفة وحدة واحدة إذا حددت مجموعة البيانات الجنس، أو وحدتين إجمالًا عند استخدام الذكاء الاصطناعي. تُحتسب أيضًا التوقعات المكتملة التي يبقى جنسها غير معروف. تكفي وحدة واحدة لبدء الطلب المجمّع، وقد يصبح الرصيد سالبًا بعد الخصم النهائي.