ما هو تكامل API؟ الطرق وما يجب الانتباه إليه

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

لماذا يلزم التكامل؟

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

أربع طرق أساسية

1. الطلب اللحظي (REST API)

يسأل نظامٌ النظام الآخر لحظة احتياجه إلى المعلومة ويتلقى الرد. وهو مناسب لعمليات مثل الاستعلام عن المخزون أو جلب الأسعار أو إنشاء سجل. وهو اليوم الطريقة الأكثر شيوعًا.

2. Webhook (إشعار الأحداث)

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

3. النقل المجدول على دفعات

تُنقل البيانات على فترات محددة وبصورة مجمَّعة. وبهذه الطريقة تُنفَّذ عمليات التسوية التي تعمل ليلًا أو تبادل البيانات عبر الملفات مع الأنظمة القديمة التي لا تقدّم API. ليست لحظية، لكنها بسيطة ومتينة.

4. طابور الرسائل

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

الحاجة	الطريقة المناسبة
مطلوب رد فوري	الطلب اللحظي
العلم بوقوع حدث ما	Webhook
بيانات كبيرة الحجم ومرنة من حيث التوقيت	النقل على دفعات
عمليات كثيفة وتحمّل للانقطاع	طابور الرسائل

ما يجب الانتباه إليه من أجل تكامل موثوق

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

ما العمل مع الأنظمة التي لا تملك API؟

ليس كل برنامج يقدّم API. في هذه الحالة تُدرس خيارات مثل نقل الملفات أو القراءة على مستوى قاعدة البيانات أو خدمة وسيطة تعمل بين الطرفين. ولكلٍّ منها مخاطر مختلفة؛ والطريقة التي تدعمها الجهة المنتجة للبرنامج يجب أن تكون الخيار الأول دائمًا.

أسئلة يجب الإجابة عنها قبل البدء

1. أي بيانات ستتدفق، وفي أي اتجاه، وبأي وتيرة؟
2. عند حدوث تعارض، بيانات أي نظام ستُعدّ الصحيحة؟
3. هل للنظام المقابل توثيق وبيئة اختبار؟
4. كيف سيستمر العمل عند توقف التكامل؟
5. من سيراقب الأخطاء ومن سيتدخل؟

لربط أنظمتكم بعضها ببعض، يمكنكم الاطلاع على خدمتنا في واجهات API وتكامل الأنظمة.