مفتاح API

يحدد مفتاح API حساب المطور الذي يرسل الطلب إلى واجهات GVR البرمجية.

إدارة المفتاح

يمكنك إنشاء مفتاح API أو عرضه أو تدويره أو حذفه من تطبيق GVR. يشرح هذا الدليل كيفية استخدام المفتاح بعد ظهوره في حسابك.

استخدام المفتاح

أرسل المفتاح إلى نقاط نهاية المطورين ضمن ترويسة apiKey:

apiKey: YOUR_API_KEY

أضف ترويسة نوع المحتوى المعتادة لطلبات JSON أيضًا:

Content-Type: application/json
apiKey: YOUR_API_KEY

عند رفع الملفات، أرسل المفتاح ضمن طلب نموذج multipart.

دورة حياة المفتاح

إذا دوّرت المفتاح أو حذفته من تطبيق GVR، فستفشل الطلبات التي تستخدم المفتاح القديم وتعيد رسالة الخطأ التالية:

{
  "error": "Invalid API key"
}

ملاحظات الأمان

• خزّن المفاتيح في متغيرات بيئة على الخادم.
• لا تودع المفاتيح في مستودع الشيفرة.
• لا تكشف المفاتيح ضمن ملفات الواجهة الأمامية العامة.
• إذا كُشف المفتاح عن طريق الخطأ، فقم بتدويره من تطبيق GVR.