ما هو ال API

API هي اختصار لـ "Application Programming Interface"، وهي واجهة برمجية تستخدم للتواصل بين تطبيقين أو برامج مختلفة. وعندما يقوم مبرمج الباكاند بطلب API منك، فإنه يريد منك إعطائه وصولًا إلى بعض البيانات أو الخدمات التي يحتاجها لتطوير الجزء الخلفي من الموقع.

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

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

وفيما يلي مثال لطلب API:

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

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

GET /api/products - استراد قائمة المنتجات
Parameters: None
Response:
{
 "products": [
  {
   "id": 1,
   "name": "Product 1",
   "description": "This is product 1",
   "price": 10.99
  },
  {
   "id": 2,
   "name": "Product 2",
   "description": "This is product 2",
   "price": 20.99
  }
 ]
}

GET /api/products/{id} - استراد تفاصيل المنتج الخاص بالـ ID المحدد
Parameters:
- id: رقم التعريف الفريد للمنتج
Response:
{
 "id": 1,
 "name": "Product 1",
 "description": "This is product 1",
 "price": 10.99
}

ويمكن أن يتم استدعاء هذه الواجهة برمجية عن طريق إجراء طلب HTTP GET إلى عنوان URL المحدد، مع تحديد معلمات الطلب المطلوبة. على سبيل المثال، يمكن استدعاء واجهة برمجية لاستراد قائمة المنتجات باستخدام العنوان التالي:

http://example.com/api/products

ويمكن أن يتم تغيير المعلمات المحددة في الطلب لتحديد المنتج الذي يجب استراد تفاصيله، على سبيل المثال:

http://example.com/api/products/1

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