مفاتيح واجهة برمجية

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

هذه الصفحة للمالكين والمطورين. إذا لم يكن في فريقكم مهندسون، فالأرجح أنكم لن تفتحوها أبدًا.

إنشاء مفتاح

سمِّ المفتاح بحسب ما سيقوم به، وأكّد برمز من تطبيق المصادقة، فيُعرض السر مرة واحدة.

في العرض المجمّع جميع البيئات يُلزمك مربع الحوار باختيار البيئة التي ينتمي إليها المفتاح، لأنه لا يوجد ما يمكن استنتاجها منه.

قراءة وكتابة، أو قراءة فقط

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

القراءة فقط لا تقول شيئًا عن مقدار ما يستطيع المفتاح قراءته. فهذا هو السؤال التالي في مربع الحوار، والأمران مستقلان: يمكن قصر مفتاح القراءة فقط على النتائج، ويمكن لمفتاح القراءة والكتابة أن يقرأ كل شيء.

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

تحمل مفاتيح القراءة فقط علامة تدل على ذلك في القائمة، فترى بنظرة واحدة أيًّا من بيانات اعتمادك قادر على تغيير أي شيء. أما مفاتيح القراءة والكتابة فلا تحمل أي علامة، لأنها الحالة المعتادة.

ما الذي يستطيع هذا المفتاح قراءته

السؤال الثالث في مربع حوار الإنشاء يحدد مقدار ما يستطيع المفتاح رؤيته من عملية التحقق.

النتائج فقط هو الخيار الافتراضي، وهو ما عليه كل مفتاح لديكم حاليًا. يقرأ الحالة، والحكم، ورموز الأسباب، ونتيجة كل فحص على حدة. ولا يستطيع قراءة الشخص: لا اسم، ولا تاريخ ميلاد، ولا رقم مستند، ولا صور.

البيانات الكاملة يضيف كل ذلك. الهوية التي قرأناها من المستند، بما في ذلك التهجئة بالخط الأصلي والتواريخ كما تطبعها البطاقة تمامًا، والصور الملتقطة للمستند والصورة الذاتية. ويطلبها تكاملكم في كل استدعاء على حدة، باستخدام include=applicant,documents على عملية التحقق، لذا فالمفتاح الذي يملكها يظل يعيد النتيجة المجردة ما لم تطلبوا المزيد.

اختر البيانات الكاملة حين يحتاج شيء لديكم إلى الشخص لا إلى الجواب فقط: بطاقة عميل في أداة الدعم لديكم، أو مزامنة ليلية مع أنظمتكم، أو ملف امتثال. واقرنها بالقراءة فقط، فيستطيع ذلك الشيء رؤية كل شيء دون تغيير أي شيء.

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

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

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

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

التدوير والإلغاء

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

تأكيد المفتاح المباشر يقول ذلك صراحةً. اقرأه قبل أن توافق عليه.

آخر استخدام، وما كان المفتاح يفعله

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

اختر مفتاحًا فتعرض لوحة حركته الأخيرة. وهي مأخوذة من سجلات التكامل، لذا فالدور الذي لا يملك السجلات يرى المفتاح لا سجله، وتقول اللوحة ذلك بدلًا من عرض مخطط فارغ.

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

أعمال تنظيمية تستحق القيام بها

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