إنتقل إلى المحتوى الرئيسي

المصادقة

نقاط نهاية المطورين في GVR محمية بالمصادقة باستخدام مفتاح API.

عنوان URL الأساسي​

https://api.genderrecognition.com

ترويسات الطلب​

أرسل المفتاح ضمن ترويسة apiKey:

apiKey: YOUR_API_KEY

يقرأ الخادم هذه الترويسة باسم apikey، لذا لا يهم اختلاف حالة الأحرف في عملاء HTTP المعتادين.

مثال​

curl -X POST "https://api.genderrecognition.com/v1/voice-gender-recognition/api/name" \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_API_KEY" \
  -d '{
  "firstName": "Alex",
  "lastName": "Morgan"
}'

عند فشل المصادقة​

مفتاح API مفقود​

{
  "error": "API key is required"
}

مفتاح API غير صالح​

{
  "error": "Invalid API key"
}

خطأ داخلي في خدمة المصادقة​

{
  "error": "Internal server error"
}

قد تفشل الطلبات أيضًا في الحالات التالية:

  • لا توجد طلبات متبقية ضمن حصة المفتاح
  • لم يجتز محتوى الطلب التحقق
  • الملف المرفوع مفقود أو كبير جدًا أو بتنسيق غير مدعوم

يسرد دليل كل نقطة نهاية استجابات الأخطاء الخاصة بواجهة API تلك.

حافظ على سرية المفاتيح ودوّرها إذا كُشفت.