API Documentation

التعريف

هي دليل تقني يشرح كيفية استخدام واجهة برمجة التطبيقات (API) والربط معها. تتضمن عادةً تفاصيل حول نقاط النهاية (endpoints) المتاحة، ومعاملات الطلب، وأمثلة على الاستجابات.

أين تسمعه؟

أثناء تطوير الـ API، أو عند انضمام مطورين جدد للفريق، أو عند محاولة الربط مع خدمة خارجية.

أمثلة

• Please check the API documentation to see which fields are required for this request.يرجى مراجعة الـ API documentation لمعرفة الحقول المطلوبة لهذا الطلب.
• Our team needs to update the API documentation before we release the new version.يحتاج فريقنا إلى تحديث الـ API documentation قبل إطلاق النسخة الجديدة.