كيف تعمل طلبات واجهة برمجة التطبيقات، والاستجابات، والأحمال المفيدة؟
طلب واجهة برمجة التطبيقات هو رسالة تُرسل من تطبيق إلى آخر لاسترداد المعلومات أو تنفيذ عملية مدعومة.
تقوم التطبيق المستلم بمعالجة الطلب وعادةً ما تعيد استجابة HTTP.
يساعد فهم الطلبات والاستجابات الشركات على تكوين واختبار واستكشاف مشكلات التكاملات الخارجية.
ماذا يحتوي طلب واجهة برمجة التطبيقات؟
اعتمادًا على المزود، قد يتضمن الطلب:
1. عنوان URL لنقطة النهاية.
2. طريقة HTTP.
3. معلومات المصادقة.
4. رؤوس الطلب.
5. معلمات الاستعلام.
6. جسم الطلب.
7. معرفات للسجلات أو الموارد المعنية.
لا تتطلب كل طلب جميع هذه المكونات.
طرق HTTP الشائعة
GET
تستخدم عادةً لاسترداد المعلومات.
POST
تستخدم عادةً لإرسال المعلومات أو بدء عملية.
PUT
تستخدم عادةً لاستبدال أو تحديث مورد.
PATCH
تستخدم عادةً لتطبيق تغييرات جزئية.
DELETE
تستخدم عادةً لإزالة مورد.
السلوك الفعلي يتم تحديده بواسطة واجهة برمجة التطبيقات الخارجية.
ما هو الحمولة في واجهة برمجة التطبيقات؟
الحمولة هي البيانات التي يتم نقلها في طلب أو استجابة.
تستخدم العديد من واجهات برمجة التطبيقات JSON، على الرغم من أن تنسيقات أخرى ممكنة.
قد تحتوي الحمولة JSON على حقول مثل معرفات العملاء، حالات السجلات، الطوابع الزمنية، أو المعلمات التشغيلية.
ما هي استجابة واجهة برمجة التطبيقات؟
تحتوي الاستجابة عادةً على رمز حالة HTTP وقد تتضمن جسم استجابة.
يمكن أن يحتوي جسم الاستجابة على المعلومات المطلوبة، تأكيد عملية، أو تفاصيل خطأ.
رموز استجابة HTTP الشائعة
200 — كانت الطلب ناجحًا.
201 — تم إنشاء مورد.
202 — تم قبول الطلب للمعالجة، ولكن قد لا تكون المعالجة مكتملة.
204 — نجح الطلب بدون جسم استجابة.
400 — الطلب غير صالح.
401 — المصادقة مفقودة أو غير صالحة.
403 — الوصول محظور.
404 — لم يتم العثور على المورد المطلوب.
409 — حدث تعارض.
429 — تم تحديد معدل الطلب.
500 — واجهت الخدمة الخارجية خطأ داخليًا.
503 — الخدمة غير متاحة مؤقتًا.
هذه هي المعاني الشائعة لـ HTTP. قد توفر واجهات برمجة التطبيقات الفردية تفاصيل إضافية.
هل يعني HTTP 200 دائمًا أن العملية التجارية اكتملت بشكل صحيح؟
ليس بالضرورة.
تؤكد استجابة HTTP الناجحة أن الخادم تعامل مع الطلب وفقًا لعقد واجهة برمجة التطبيقات الخاصة به.
يجب التحقق من البيانات المعادة والنتيجة التجارية اللاحقة.
ماذا يحدث إذا أعادت واجهة برمجة التطبيقات معلومات غير مكتملة؟
راجع هيكل استجابة المزود، الأذونات، الحقول المطلوبة، قواعد الترقيم، وتوافر البيانات.
تقوم بعض واجهات برمجة التطبيقات بإرجاع حقول محددة فقط أو عدد محدود من السجلات لكل طلب.
ما هي الترقيم؟
الترقيم هو آلية تقسم مجموعات كبيرة من السجلات إلى مجموعات أصغر.
قد تحتاج التكاملات إلى طلب صفحات متعددة لاسترداد مجموعة كاملة.
ما هو تخطيط البيانات؟
تخطيط البيانات يحدد كيفية تطابق الحقول من نظام واحد مع الحقول في نظام آخر.
على سبيل المثال، قد تمثل نظامان نفس المعلومات التجارية باستخدام أسماء أو هياكل حقول مختلفة.
كيف يجب أن أتحقق من صحة عملية واجهة برمجة التطبيقات؟
الخطوة 1: تأكيد نقطة النهاية وطريقة HTTP.
الخطوة 2: تحقق من المصادقة.
الخطوة 3: تحقق من المعلمات المطلوبة.
الخطوة 4: أرسل طلبًا محكومًا.
الخطوة 5: افحص استجابة HTTP.
الخطوة 6: تحقق من المعلومات المعادة.
الخطوة 7: تأكيد النتيجة التجارية المتوقعة.
الخطوة 8: راجع معالجة الأخطاء قبل الاستخدام في الإنتاج.
النهج الموصى به
اعتبر الاتصال الناجح ومعالجة الأعمال الناجحة كمتطلبات تحقق منفصلة.
يجب تأكيد كلاهما قبل الاعتماد على تكامل واجهة برمجة التطبيقات للعمليات المهمة.