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

في ASAP، يمكنك استخدام واجهة برمجة التطبيقات المفتوحة للتفاعل مع حلول الأطراف الخارجية. تعمل واجهة برمجة التطبيقات المفتوحة عبر HTTP وتقدم مجموعة من طرق الطلب / الاستجابة.

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

<عنوان موقع بوابة ASAP، الذي يُستخدم للتفاعل عبر واجهة برمجة التطبيقات المفتوحة>/openapi/<إصدار API>/<الطلب>

لا تدعم كل طريقة أكثر من 10 طلبات في الثانية (RPS).‏

كيفية الحصول على عنوان موقع ASAP، الذي يستخدم للتفاعل عبر واجهة برمجة التطبيقات

للحصول على عنوان موقع واجهة برمجة التطبيقات المفتوحة لحل ASAP:‏

1. سجل الدخول إلى منصة ويب ASAP.‏
2. في القسم لوحة المعلومات، انقر على الزر استيراد ومزامنة، ثم افتح علامة التبويب واجهة برمجة التطبيقات المفتوحة.‏
3. يوجد رابط الاتصال بحل ASAP عبر واجهة برمجة التطبيقات المفتوحة في أسفل النافذة. انسخه واحفظه بالطريقة التي تناسبك.

كيفية تمكين الوصول عبر واجهة برمجة التطبيقات وإنشاء رمز مميز

لمنح الإذن للطلبات، يجب توقيعها بواسطة رمز مميز يتم إنشاؤه على منصة ASAP.‏ يستطيع مسؤولو الشركة فقط إنشاء الرموز المميزة.

لإنشاء رمز مميز:

1. سجل الدخول إلى منصة ويب ASAP.‏
2. في القسم لوحة المعلومات، انقر على الزر استيراد ومزامنة، ثم افتح علامة التبويب واجهة برمجة التطبيقات المفتوحة.‏
3. انقر على الزر رمز مميز جديد.

   ستفتح نافذة الحصول على رمز مميز.‏

4. انسخ الرمز المميز واحفظه بالطريقة التي تناسبك.

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

يكون الرمز المميز الذي تم إصداره صالحًا لمدة 12 شهرًا. عندما تنتهي هذه الفترة، يتم إبطال الرمز المميز. يتم أيضًا إبطال الرمز المميز الذي تم إصداره إذا لم يتم استخدامه لمدة 6 أشهر.

المصادقة

يجب إضافة الرمز المميز الذي تم الحصول عليه على ASAP إلى رؤوس جميع طلبات واجهة برمجة التطبيقات. ويجب أن يبدو الرأس كما يلي:

Authorization: Bearer <الرمز المميز المستلم على منصة ASAP> ContentType 'application/json; charset=utf-8'

تنسيق الرد

JSON هو التنسيق الافتراضي للردود على طلبات واجهة برمجة التطبيقات.

مثال على استدعاء CURL

يوجد أدناه طلب واجهة برمجة تطبيقات إلى https://domain.com/، والذي يستخدم طريقة "GET openapi/v1/groups" (احصل على قائمة بالمجموعات). يصادق الطلب باستخدام الرمز المميز e8c699c05d495566a94bbb6841894153.‏

curl -X GET "https://domain.com/openapi/v1/groups" -H "accept: application/json" -H "Authorization: Bearer Token:e8c699c05d495566a94bbb6841894153"

تجد في قسم التعليمات هذا طريقة "POST /openapi/v1/users/info" طريقة "GET /openapi/v1/groups" طريقة "POST /openapi/v1/users" طريقة "POST /openapi/v1/report" طريقة "PATCH /openapi/v1/user/:userId" طريقة "DELETE /openapi/v1/user/:userId"

إلى أعلى الصفحة