API العميل

إذا اختلفت هذه الترجمة عن النسخة الإنجليزية، تسود النسخة الإنجليزية.

تعد Client API خدمة محلية داخل التطبيق للأتمتة المتقدمة. إنها ليست واجهة برمجة تطبيقات السحابة العامة ولا ينبغي تعريضها لشبكات غير موثوقة.

الاستخدامات النموذجية

استخدم واجهة برمجة التطبيقات المحلية عندما تريد برنامجًا نصيًا موثوقًا أو أداة محلية للقيام بما يلي:

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

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

يتضمن التطبيق مجموعات نقاط النهاية من أجل:

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

يمكن أن تتغير أشكال الحمولة الفعلية مع إصدارات التطبيق. تحقق من تنفيذ التطبيق عند إنشاء تكامل صارم.

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

المرشحين الجيدين:

المرشحين الخطرين:

مشكلة	ما يجب التحقق منه
الطلب غير مصرح به	حالة تسجيل الدخول و”X-API-SECRET”.
لا يمكن تحرير المجموعة	ملكية المجموعة وحالة القراءة فقط والتوافق مع نوع المجموعة.
فشل تحميل المورد	بالإضافة إلى حدود المرفقات ومسار الملف وحجمه والشبكة.
المزامنة لا تقوم بتحديث جهاز آخر	قم بتشغيل المزامنة على كلا الجهازين وانتظر الموارد.
خطأ في الحمولة	قارن طلبك مع تنفيذ التطبيق الحالي.