الاستخدام الأساسي
نفّذ أول طلب إلى GenderAPI
أرسل قيمة إدخال واحدة واحصل على الجنس المتوقع ونسبة الاحتمال والدولة ومعلومات الاستخدام. ابدأ بالاسم، واستخدم نقطة البريد الإلكتروني أو اسم المستخدم عندما تكون هذه هي البيانات المتاحة لديك.
أضف مفتاح API عبر معامل الاستعلام key. احتفظ بمفاتيح production على خادمك، ولا تعرض مفتاحاً خاصاً داخل كود المتصفح أو مستودع عام.
استخدم عقد GenderAPI الحالي بصيغة OpenAPI أو Swagger أو Postman.
تحديد الجنس من الاسم
اسم شخصي أو اسم كامل
استخدم نقطة النهاية الأساسية عندما يكون الإدخال اسماً شخصياً أو اسماً كاملاً.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"المعاملات الاختيارية
| المعامل | النوع | الوصف |
|---|---|---|
country | string | رمز دولة من حرفين مثل SA أو US. |
askToAI | boolean | عند true يُستدعى دعم الذكاء الاصطناعي إذا لم يوجد الاسم في قاعدة البيانات. |
forceToGenderize | boolean | يحاول توقع المدخلات غير المعتادة التي قد لا تبدو كأسماء بشرية. |
تحديد الجنس من البريد
عنوان البريد الإلكتروني
تستخرج نقطة البريد الإلكتروني اسماً محتملاً من العنوان قبل تنفيذ تحليل الجنس.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=SA&askToAI=true&key=YOUR_API_KEY"forceToGenderize غير متاح لهذه النقطة لأن الاسم يُستخرج داخلياً.تحديد الجنس من اسم المستخدم
معرّف التواصل الاجتماعي
استخدم هذه النقطة لأسماء المستخدمين والمعرّفات والألقاب التي قد تتضمن اسماً يمكن التعرف إليه.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=SA&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"استجابة JSON
افهم استجابة GenderAPI
تستخدم نقاط النهاية الثلاث البنية الأساسية نفسها للاستجابة.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "US",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}حقول الاستجابة
| الحقل | النوع | الوصف |
|---|---|---|
status | boolean | ما إذا كان الطلب قد اكتمل بنجاح. |
used_credits | integer | عدد أرصدة API التي استهلكها هذا الطلب. |
remaining_credits | integer | الأرصدة المتبقية بعد تنفيذ الطلب. |
expires | integer | وقت انتهاء الباقة بصيغة UNIX timestamp. |
q | string | استعلام الاسم أو البريد الإلكتروني أو اسم المستخدم الأصلي. |
name | string | الاسم الشخصي بعد التطبيع أو الاستخراج. |
gender | string | الجنس المتوقع: male أو female أو "null". |
country | string | رمز الدولة الأرجح وفق ISO 3166-1 alpha-2. |
total_names | integer | عدد سجلات الأسماء التي يستند إليها التوقع. |
probability | integer | درجة الثقة في التوقع كنسبة مئوية. |
duration | string | وقت معالجة الطلب على الخادم. |
شفّر قيم الإدخال دائماً بصيغة URL
يجب أن يشفّر عميل HTTP المسافات والرموز الخاصة. استخدم مثلاً sparkling%20unicorn بدلاً من مسافة خام.
تابع التطوير