مفاتيح API المقيّدة - الوصول المحدود إلى KYC API

---

يبدأ كل تطبيق بـسر أساسي يملك وصولاً كاملاً إلى كل ما يستطيع التطبيق القيام به. يمكنك إضافة مفاتيح API مسمّاة بجانبه، واحد لكل خدمة أو شريك، ولكل منها الوصول الذي يحتاجه فقط. امنح مزوّد المدفوعات لديك مفتاحاً يقرأ الجلسات المقبولة لسير عمل واحد ولا يستطيع تغيير أي شيء، واحتفظ بمفتاح منفصل لخادمك الخلفي، ويمكنك إلغاء أي منهما دون المساس بالآخر.

---

​

أين تجدها

في وحدة تحكم الأعمال، اختر تطبيقك وافتح Developers -> API keys. تعرض القائمة كل مفاتيح التطبيق مع حالة كل منها، وعدد طلباتها خلال آخر 30 يوماً، ومن أنشأها، وصلاحياتها، وآخر مرة استُخدمت فيها. انقر على مفتاح لمعاينته على اليمين، أو افتح صفحته الكاملة للاطلاع على الاستخدام والوصول وآخر الطلبات ومقتطف البدء السريع ونشاطه. تنتمي المفاتيح إلى تطبيق واحد ولا تعمل إلا له. يتبع المفتاح بيئة التطبيق: فمفاتيح تطبيق في البيئة التجريبية لا تنشئ عمليات تحقق مفوترة أبداً.

---

​

روابط إعادة التوجيه والنطاقات المسموح بها

افتح Developers > API keys > Redirects and domains لضبط قائمتين للتطبيق والبيئة المحددين لديك. عندما تحتوي قائمة Allowed domains على مدخلات، يرفض إنشاء جلسة أي callback لا يقع ضمن إحداها، ويعيد خطأ 400. القائمة الفارغة تعني عدم وجود أي قيد. لا تتأثر استدعاءات الخادم إلى الخادم بذلك.

---

​

إنشاء مفتاح

​

الإعدادات المسبقة

​

الموارد

القراءة تشمل طلبات GET على المورد، أما الكتابة فتشمل أيضًا POST وPUT وPATCH وDELETE. يعمل المفتاح ذو الوصول المخصص مع الواجهة البرمجية العامة: endpoints الخاصة بالجلسات والمستخدمين والشركات والمعاملات وسير العمل وwebhook، وكذلك الفحوصات المستقلة. ترد نقاط النهاية التي تستخدمها لوحة Business Console فقط بالرمز 403 لهذا المفتاح، وهي تحتاج إلى مفتاح بوصول كامل. المفتاح الذي لا يملك صلاحية قراءة الوسائط يتلقى قرارات الجلسات مع ضبط كل رابط للصورة والفيديو وPDF على null، وترد نقاط نهاية تقارير PDF بالرمز 403. لا يتلقى المفتاح الذي لا يملك صلاحية كتابة الجلسات أبدًا رابط التحقق أو رمز الجلسة الخاص بأي جلسة، لأن من يحملهما يستطيع إكمال التحقق باسم المستخدم النهائي، لذلك تعود هذه الحقول بالقيمة null. ولهذا السبب نفسه، فإن إنشاء شخص مع send_verification_link: true يتطلب صلاحية كتابة الجلسات إلى جانب صلاحية كتابة الأشخاص، لأنه ينشئ جلسة ويرسل رابطها بالبريد الإلكتروني. ومن دونها، يرد الطلب بالرمز 403 ولا ينشئ شيئًا.

​

الحدود

يعمل المفتاح المقيَّد ببعض سير العمل أو بالجلسات المقبولة فقط على نقاط نهاية الجلسات، حيث يمكن تطبيق الحد. ولا يستطيع الوصول إلى الأشخاص أو الشركات أو المعاملات أو التحليلات، ولا يستطيع تشغيل الفحوصات المستقلة.

---

​

كيف ترد واجهة API على مفتاح محدود النطاق

لا تعيد قوائم الجلسات إلا الجلسات التي تسمح بها حدود المفتاح.

---

​

تعديل الوصول

افتح قائمة المفتاح أو معاينته أو صفحته، واختر تعديل الوصول. غيّر الإعداد المسبق أو الموارد أو الحدود أو تاريخ الانتهاء، ثم راجع التغييرات فقط، مع القيم قبل التعديل وبعده. يبقى السر كما هو، فلا حاجة إلى إعادة النشر، ويُطبَّق الوصول الجديد خلال دقيقة. يملك السر الأساسي دائمًا وصولًا كاملًا، ولا يمكن تعديله.

---

​

تدوير مفتاح

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

---

​

إلغاء مفتاح

الإلغاء يوقف المفتاح فورًا: ترد كل الطلبات المرسلة به بالرمز 401. ولا يمكن التراجع عنه. لا يمكن إلغاء السر الأساسي، بل أعد تدويره بدلًا من ذلك.

---

​

الاستخدام وسجل التدقيق

يعرض كل مفتاح طلباته خلال آخر 30 يومًا، ومعدل الأخطاء، وزمن الاستجابة، وأحدث طلباته مع رموز حالتها، بما فيها الطلبات التي رفضتها حدوده. تظهر كل استدعاء يُجرى بمفتاح API في سجلات التدقيق الخاصة بالمؤسسة، مع اسم المفتاح الذي أجراه.

​

من يمكنه إدارة المفاتيح

تتطلب إدارة مفاتيح API الإذن مفاتيح API: قراءة لعرضها، وكتابة لإنشائها وتعديلها وتدويرها وإلغائها. راجع الأدوار والأذونات.