واجهة API خارجية

تتيح واجهات API الخارجية لـ Chakra التواصل مع العالم الخارجي. وباستخدامها، يمكنك إنشاء أي نوع من تكامل API على نظامنا. الأمر بسيط بقدر استخدام عميل HTTP مثل postman أو insomnia. تساعدك واجهات API الخارجية على جلب البيانات من تطبيقاتك الداخلية أو منتجات البرامج الأخرى وإرسالها إليها.

طرق HTTP

تدعم واجهة API الخارجية طرق HTTP القياسية

GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD

نوع نص الطلب

تُدعم أنواع نصوص طلب HTTP القياسية. القائمة أدناه:

NONE
JSON
FORM-MULTIPART
XML
FORM-URL-ENCODED

إعدادات أخرى

يمكنك أيضًا إعداد

ترويسات الطلب
معلمات الاستعلام

تحويل الطلب/الاستجابة

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

التخزين المؤقت

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

تنبيهات الأخطاء

يمكنك اختيار إعداد تنبيهات الأخطاء لتلقي تنبيه كلما حدث خطأ في إحدى واجهات API. تُرسل التنبيهات عبر البريد الإلكتروني، ولا يمكن إرسالها إلا إلى المستخدمين على Chakra. ويمكنك أيضًا تحديد معايير الأخطاء لواجهة API الخاصة بك. افتراضيًا، تُعد الاستجابة التي لا تحمل الرمز 2xx خطأً.

السجلات

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