طلبات API الخارجية

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

تعريف

راجع المواصفات الخاصة بكيفية تنظيم الطلب في وثائق واجهة برمجة التطبيقات لمزود الخدمة الذي تريد الاتصال به.

1. لتحديد قالب طلب جديد ، انتقل إلى علامة التبويب "منطق الأعمال" على الشريط الجانبي (1) ، وقم بالتبديل إلى علامة التبويب "طلبات واجهة برمجة التطبيقات الخارجية" (2) ، وانقر فوق "طلب واجهة برمجة تطبيقات جديد" (3).

2. امنح الطلب الجديد اسمًا ووصفًا اختياريًا.

3. حدد طريقة HTTP للطلب وعنوان URL الخاص بها.

4. حدد معلمات URL ومعلمات الاستعلام (لطلبات GET فقط) والعناوين وجسم الطلب عن طريق إدخال اسم المعلمة (1) ونوعه (2) والنقر فوق "إضافة معلمة" (3).

سيتم تحديد القيمة الفعلية لهذه المعلمات في وقت تنفيذ عملية الأعمال ، حيث يتم تشغيل الطلب.

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

يمكنك أيضًا الملء التلقائي لرؤوس الطلب والجسم عن طريق إدخال نموذج JSON ، وسيقوم النظام بإنشاء جميع المعلمات الضرورية تلقائيًا.

ليس عليك إضافة معلمات جديدة في كل علامة تبويب. قد لا تحتوي بعض الطلبات على أي معلمات عناوين URL أو رؤوس أو نص على الإطلاق ، على سبيل المثال.

في حالة احتواء طلبك على كائنات (مثل السيارة -> اللون والحجم وما إلى ذلك) ، فسيتعين عليك إنشاء نماذج افتراضية لمعالجة هذه الكائنات لاحقًا في عمليات عملك. قم بذلك عن طريق تحديد "Model" في محدد نوع المعامل ، وتقديم العناصر الفرعية التي قد تحتاجها. يمكنك تداخل الكائنات عدة مرات حسب حاجتك (أي كائن داخل كائن) وإنشاء مصفوفات نموذج افتراضي. في حالة استخدامك للتعبئة التلقائية ، يتم إكمال هذه العملية تلقائيًا.

5. قم بتغيير إعدادات الطلب ، مثل التحقق من SSL ، والمهلة ، ومعالجة الأخطاء في علامة التبويب "الإعدادات".

6. اختبر الطلب بالنقر فوق "طلب اختبار" وإدخال جميع المعلمات المطلوبة. تحقق من الاستجابة من الخادم وقم بتعبئة رؤوس الاستجابة والجسم تلقائيًا تلقائيًا ، أو قم بذلك يدويًا.

7. احفظ نموذج الطلب بالنقر فوق "حفظ الطلب".

يستخدم

بعد تحديد طلب جديد وحفظه ، ستصبح كتلة جديدة متاحة في Business Process Editor لتشغيله.

سيتعين عليك تزويده بجميع المكونات التي ترغب في إضافتها إلى الطلب (عنوان URL ومعلمات الاستعلام ، والعناوين ، والجسم) كنماذج بيانات ، والتي يمكن إجراؤها باستخدام هذه الكتل. في الإخراج ، ستتمكن من استخراج النص المنسق للاستجابة ورؤوسها وحالة الاستجابة. يمكنك توسيع هذه النماذج باستخدام هذه الكتل.

لا يتعين عليك توصيل جميع مدخلات البيانات حتى يتم تشغيل الطلب بشكل صحيح. على سبيل المثال ، إذا كان لديك طلب بدون معامِلات عناوين URL ، فلا داعي لإنشاء النموذج الخاص به وربطه.

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

يراقب

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