الأسماء وعناوين البريد الإلكتروني وأسماء المستخدمين في طلب مجمّع
| المعامل | النوع | مطلوب | القيمة الافتراضية | الوصف |
|---|---|---|---|---|
items | array<object> | نعم | — | 1–50 عنصر تقدير؛ و10 عناصر كحد أقصى في التجربة حسب عنوان IP. تحافظ النتائج على ترتيب الإدخال. |
items[].type | string | نعم | — | فئة الإدخال: name أو email أو username. |
items[].value | string | نعم | — | مطلوب. 1–254 حرفًا؛ غير فارغ ودون أحرف تحكم. يجب أن تكون قيم email بصيغة بريد إلكتروني صالحة. |
items[].country | string | لا | — | رمز ISO 3166-1 alpha-2 اختياري بأحرف كبيرة، مثل TR أو US. قد يرجع البحث الخاص بدولة إلى مجموعة البيانات العامة. |
items[].forceToGenderize | boolean | لا | false | ابحث في مجموعة البيانات أولًا، ثم استخدم الذكاء الاصطناعي الذي يفسّر الأسماء المستعارة إذا لم توجد نتيجة. مدعوم لـ name وemail وusername. |
items[].options | object | لا | — | كائن يضم خيارات الذكاء الاصطناعي لكل مُدخل. |
items[].options.ai_mode | string | لا | off | القيم المسموح بها: off وfallback وalways. مع forceToGenderize: true، احذف هذا الحقل أو استخدم fallback. |
items[].id | string | لا | — | معرّف اختياري من 1–64 حرفًا في JSON لطلبات POST. يُعاد بجوار نتيجة العنصر في الطلب المجمّع، ويجب أن يكون فريدًا داخل الطلب المجمّع. يُقبل في التقديرات الفردية لكنه لا يُعاد في الاستجابة. غير مدعوم في استعلامات GET. |
يقبل GenderAPI.io V2 الأسماء وعناوين البريد الإلكتروني وأسماء المستخدمين معًا عبر POST https://api.genderapi.io/api/v2/gender/batch. أرسل مصفوفة items تضم 1–50 عنصرًا عند الوصول بمفتاح API، أو 10 عناصر كحد أقصى في التجربة حسب عنوان IP. يستخدم كل عنصر type وvalue، ويمكن أن تكون له قيم خاصة به في country وforceToGenderize وoptions. المعرّفات اختيارية ويجب أن تكون فريدة داخل الطلب المجمّع.
تحافظ النتائج على ترتيب الإدخال، وتتضمن index والمعرّف الاختياري id وcharged_credits وواحدًا فقط من data أو error. قد تحتوي استجابة HTTP 200 على أخطاء في عناصر منفردة، لذا افحص كل عنصر. يعرض meta.summary القيم total وsucceeded وidentified وunknown وfailed. التقدير غير المعروف عنصر ناجح تُخصم أرصدته.
إذا فشل التحقق من الطلب أو تخطيطه، يُرفض الطلب المجمّع قبل الخصم. وإذا فشلت كل العناصر المنفَّذة، تعيد API استجابة Problem برمز حالة غير 2xx، مع مصفوفة data والاسم البديل القديم results. لا تكلّف العناصر الفاشلة شيئًا بعد تأكيد الاسترداد. وإذا لم يُؤكَّد الخصم، فلا تعدّ تكاليف العناصر نهائية.
اختر لغة البرمجة. إعداد مفتاح API، ثم شغّل المثال على خادمك.
كل طلب تقدير عملية جديدة مدفوعة، حتى عند إعادة المحاولة. لا تعيد هذه الأمثلة المحاولة تلقائيًا. تحقّق من حالة الخصم قبل إرسال طلب آخر.
قبل التشغيل: الوصول ومعالجة الأخطاء
شغّل هذه الأمثلة على خادمك. اضبط GENDERAPI_API_KEY في بيئة العملية على مفتاح API الحالي. تأكد من أن قيمة meta.access.mode هي api_key: فالمفتاح غير المعروف قد يؤدي إلى استخدام التجربة حسب عنوان IP.
في استجابات JSON ذات رموز HTTP 4xx و5xx، يُحتفظ بجسم الخطأ وينتهي المثال برمز خروج غير صفري. تحقّق من code وaction وmeta.usage.billing_status قبل إعادة المحاولة. وفي استجابات الطلب المجمّع ذات HTTP 200، افحص أيضًا data أو error في كل عنصر.
دليل الأخطاء وإعادة المحاولة ←cURL 7.76+ في واجهة أوامر POSIX. شغّله في الطرفية. وثائق بيئة التشغيل
Node.js 22+ مع fetch المدمج. احفظه باسم 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. وثائق بيئة التشغيل
تطبيق وحدة تحكم (console) على .NET 8+. استخدمه كملف Program.cs في مشروع console، ثم شغّل dotnet run. وثائق بيئة التشغيل
Go 1.22+ مع المكتبة القياسية. احفظه باسم main.go وشغّل go run main.go. وثائق بيئة التشغيل
قراءة استجابة طلب مجمّع
يجمع هذا المثال بين نتيجتين حقيقيتين جرى الحصول عليهما في 1 أكتوبر 2026، هما تطابق في مجموعة البيانات ونتيجة غير معروفة، وبين فشل توضيحي لدى مزوّد الخدمة. وهو يوضّح استجابة HTTP 200 بنجاح جزئي، لا المخرجات المتوقعة للطلب المجمّع السابق. تكلفة كل عنصر من العنصرين الناجحين رصيد واحد؛ أما العنصر الفاشل فخصمه المؤكد صفر.
{
"data": [
{
"index": 0,
"id": "known",
"charged_credits": 1,
"data": {
"input": {
"type": "name",
"value": "Ahmed",
"country": "SA"
},
"name": "ahmed",
"gender": "male",
"country": "SA",
"confidence": 0.9936783299029697,
"confidence_kind": "observed_frequency",
"sample_count": 6802,
"source": "dataset",
"result_status": "identified",
"reason": null,
"country_source": "dataset",
"match": {
"name": "ahmed",
"method": "normalized",
"scope": "country",
"country": "SA"
}
}
},
{
"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
}
}
}حقول نتائج الطلب المجمّع
| الحقل | النوع | يمكن أن يكون null | مثال | الوصف |
|---|---|---|---|---|
data | array<object> | لا | […] | نتائج مرتّبة. يحتوي كل عنصر على تقدير أو خطأ؛ فافحص كل العناصر. |
data[].index | integer | لا | 0 | الموضع في مصفوفة items المُرسلة، بدءًا من الصفر. |
data[].id | string | لا | "contact-1" | معرّف الإدخال الخاص بك، ولا يظهر إلا إذا أرسلته. |
data[].charged_credits | integer | لا | 1 | صافي خصم العنصر بعد الاسترداد المؤكد. لا تعدّه نهائيًا إذا لم يُؤكَّد الخصم الإجمالي. |
data[].data | object | لا | {…} | موجود للعنصر الناجح، بما في ذلك النتائج غير المعروفة. يستخدم حقول التقدير الموضحة في دليل الاستجابات. |
data[].error | object | لا | {…} | موجود بدلًا من data للعنصر الفاشل. يستخدم حقول Problem Details الموضحة في دليل الأخطاء. |
حقول ملخص الطلب المجمّع
| الحقل | النوع | يمكن أن يكون null | مثال | الوصف |
|---|---|---|---|---|
meta.summary.total | integer | لا | 3 | إجمالي عدد العناصر في الطلب المجمّع. |
meta.summary.succeeded | integer | لا | 2 | العناصر الناجحة، بما في ذلك التقديرات غير المعروفة. |
meta.summary.identified | integer | لا | 1 | العناصر الناجحة التي لها جنس غير null. |
meta.summary.unknown | integer | لا | 1 | العناصر الناجحة التي يكون فيها gender هو null؛ وتُخصم أرصدة هذه النتائج. |
meta.summary.failed | integer | لا | 1 | العناصر الفاشلة. total = succeeded + failed؛ succeeded = identified + unknown. |
البيانات الوصفية للوصول والخصم والطلب
| الحقل | النوع | يمكن أن يكون null | مثال | الوصف |
|---|---|---|---|---|
meta.request_id | string | لا | "550e8400-e29b-41d4-a716-446655440000" | معرّف فريد لمحاولة HTTP هذه؛ ويُرسل أيضًا في X-Request-ID. |
meta.duration_ms | integer | لا | 42 | مدة معالجة الطلب بالمللي ثانية. |
meta.access.mode | string | لا | "api_key" | api_key أو ip_trial أو unauthenticated. عند استخدام حساب مدفوع، تحقّق من ظهور api_key. |
meta.access.reason | string | نعم | null | سبب الانتقال إلى التجربة حسب عنوان IP: api_key_missing أو api_key_invalid أو api_key_not_found؛ وإلا null. |
meta.usage.charged_credits | integer | نعم | 1 | صافي الأرصدة المخصومة. صفر قبل الخصم أو بعد استرداد كامل مؤكد؛ وnull إذا لم يُؤكَّد الخصم. |
meta.usage.remaining_credits | integer | نعم | 99 | الرصيد عند اكتمال العملية. قد يكون سالبًا؛ وnull إذا لم يتوفر أو لم يُؤكَّد الخصم. |
meta.usage.billing_status | string | لا | "confirmed" | not_charged أو confirmed أو unconfirmed. تحقّق منه قبل إعادة محاولة تقدير فاشل. |
meta.usage.resets_at | string | نعم | "2026-09-27T12:00:00.000Z" | موعد تجديد التجربة حسب عنوان IP بتوقيت UTC (ISO 8601)؛ وnull لحسابات مفاتيح API أو إذا كان غير معروف. |
meta.usage.limit | integer | نعم | 10 | حصة التجربة حسب عنوان IP؛ وnull لحسابات مفاتيح API. |
meta.usage.period_seconds | integer | نعم | 86400 | مدة فترة التجربة حسب عنوان IP بالثواني؛ وnull لحسابات مفاتيح API. |
تخطيط الأرصدة وإعادة المحاولة في الطلبات المجمّعة
صادِق باستخدام مفتاح API الحالي في ترويسة Bearer، وأرسل Content-Type: application/json. كل طلب مجمّع تُرسله عملية جديدة. إذا أعدت المحاولة بعد فشل جزئي، فأرسل العناصر الفاشلة فقط بعد التحقق من الخصم؛ إذ تُخصم أرصدة العناصر الناجحة مرة أخرى إذا أُعيد إرسالها.
في عناصر الطلب المجمّع، يكون الذكاء الاصطناعي على off افتراضيًا، وتكلفة كل عنصر ناجح رصيد واحد. وتكلفة fallback الصريح أيضًا رصيد واحد إجمالًا، بما في ذلك الذكاء الاصطناعي. تكلفة always رصيدان. وتكلفة forceToGenderize رصيد واحد للنتيجة الموجودة في مجموعة البيانات أو رصيدان إذا استُخدم الذكاء الاصطناعي. تُخصم أرصدة النتائج غير المعروفة الناجحة. يكفي رصيد ابتدائي موجب قدره 1 لبدء الطلب المجمّع؛ وقد يترك الخصم النهائي رصيدًا سالبًا.
معالجة قائمة جهات اتصال دون فقدان أي صف
تتعامل نقطة نهاية الطلبات المجمّعة مع قوائم الأسماء فقط، وقوائم عناوين البريد الإلكتروني فقط، والمُدخلات المختلطة. باستخدام مفتاح API، قسّم العمل إلى طلبات مجمّعة لا يتجاوز كل منها 50 عنصرًا؛ وتسمح التجربة حسب عنوان IP بعشرة عناصر كحد أقصى في كل طلب. تتبّع موضعك في العمل، وامنح كل عنصر id فريدًا داخل الطلب المجمّع. يبدأ index المُعاد من الصفر داخل الطلب المجمّع المُرسل، لا داخل قائمة جهات الاتصال كاملة.
| الخطوة | ما يجب حفظه أو التحقق منه | لماذا يهم ذلك |
|---|---|---|
| 1. جهّز كل طلب مجمّع | احتفظ بالصف المصدر وبمعرّف العنصر؛ واضبط country وخيارات الذكاء الاصطناعي لكل عنصر. | لا تفترض أن الاسم فريد بين جميع جهات الاتصال. |
| 2. اقرأ الاستجابة كاملة | احفظ meta.request_id وطابق كل عنصر في data[] عبر id أو index. | قد تحتوي استجابة HTTP 200 على تقديرات ناجحة وعلى أخطاء في عناصر منفردة معًا. |
| 3. احفظ النتائج الناجحة | احتفظ بالتقديرات المحدَّدة وغير المعروفة، بما في ذلك قيم JSON null وحقول الأدلة. | النتيجة غير المعروفة مكتملة وتُخصم أرصدتها؛ وليست صفًا فاشلًا يُعاد إرساله تلقائيًا. |
| 4. طابِق الأخطاء والأرصدة | افحص كل error وmeta.usage.billing_status قبل أن تقرر إرسال طلب جديد. | بعد تأكيد الخصم، أعد محاولة العناصر الفاشلة التي يبرر خطؤها ذلك فقط. أما العناصر الناجحة فستُخصم أرصدتها مرة أخرى. |
| 5. أجّل إعادة المحاولة غير المؤكدة | احفظ معرّف الطلب إذا لم يُؤكَّد الخصم أو إذا جعل خطأ في الشبكة نتيجة العملية غير معروفة. | لا تُعِد إرسال الطلب المجمّع كله دون تحقق؛ اتبع أولًا إرشادات الأخطاء والخصم. |
اختيار وضع التقدير لكل جهة اتصال
يستخدم هذا الطلب القابل للتشغيل ثلاث قواعد مختلفة: مجموعة البيانات فقط لاسم كامل، والرجوع العادي إلى الذكاء الاصطناعي لعنوان بريد إلكتروني، والرجوع إلى الذكاء الاصطناعي مع تفسير الأسماء المستعارة لاسم مستخدم. هذه مُدخلات توضيحية، ولا تعني أن جهات الاتصال الثلاث ستحصل كلها على جنس. اختر لغة البرمجة فوق الكود، واضبط GENDERAPI_API_KEY قبل تشغيل المثال.
من دون forceToGenderize، يكون الذكاء الاصطناعي في عناصر الطلب المجمّع على off افتراضيًا، بخلاف عمليات البحث الفردية. حدّد fallback صراحةً إذا أردت استخدام الرجوع العادي إلى الذكاء الاصطناعي. تكلفة off والرجوع العادي كليهما رصيد واحد لكل عنصر ناجح؛ ويتخطى always مجموعة البيانات وتكلفته رصيدان. وتكلفة forceToGenderize رصيد واحد للنتيجة الموجودة في مجموعة البيانات أو رصيدان إجمالًا إذا استُخدم الذكاء الاصطناعي. تُخصم أرصدة النتائج غير المعروفة الناجحة أيضًا. لا تجمع forceToGenderize مع off أو always.
اختر لغة البرمجة. إعداد مفتاح API، ثم شغّل المثال على خادمك.
كل طلب تقدير عملية جديدة مدفوعة، حتى عند إعادة المحاولة. لا تعيد هذه الأمثلة المحاولة تلقائيًا. تحقّق من حالة الخصم قبل إرسال طلب آخر.
قبل التشغيل: الوصول ومعالجة الأخطاء
شغّل هذه الأمثلة على خادمك. اضبط GENDERAPI_API_KEY في بيئة العملية على مفتاح API الحالي. تأكد من أن قيمة meta.access.mode هي api_key: فالمفتاح غير المعروف قد يؤدي إلى استخدام التجربة حسب عنوان IP.
في استجابات JSON ذات رموز HTTP 4xx و5xx، يُحتفظ بجسم الخطأ وينتهي المثال برمز خروج غير صفري. تحقّق من code وaction وmeta.usage.billing_status قبل إعادة المحاولة. وفي استجابات الطلب المجمّع ذات HTTP 200، افحص أيضًا data أو error في كل عنصر.
دليل الأخطاء وإعادة المحاولة ←cURL 7.76+ في واجهة أوامر POSIX. شغّله في الطرفية. وثائق بيئة التشغيل
Node.js 22+ مع fetch المدمج. احفظه باسم 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. وثائق بيئة التشغيل
تطبيق وحدة تحكم (console) على .NET 8+. استخدمه كملف Program.cs في مشروع console، ثم شغّل dotnet run. وثائق بيئة التشغيل
Go 1.22+ مع المكتبة القياسية. احفظه باسم main.go وشغّل go run main.go. وثائق بيئة التشغيل