ماذا يعني API؟

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

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

قد تسمع مصطلح "الخدمات الصغيرة" يتعلق بواجهة برمجة التطبيقات (API). ومع ذلك، هذه ليست هي نفسها. الخدمات المصغرة هي أسلوب أو بنية تقسم الوظائف داخل تطبيق الويب. بينما API هو الإطار الذي يتفاعل فيه المطورون مع تطبيق الويب. يمكن للخدمات الصغيرة في الواقع استخدم API للتواصل بينهما.

تتيح واجهة برمجة التطبيقات (API) للمطور إجراء "مكالمة" أو "طلب" محدد لإرسال المعلومات أو تلقيها. ويتم هذا الاتصال باستخدام لغة برمجة تسمى "JSON". ويمكن استخدامه أيضًا لاتخاذ إجراء محدد مثل تحديث البيانات أو حذفها. هناك أربع طرق طلب أساسية يمكن إجراؤها باستخدام واجهة برمجة التطبيقات:

الحصول على - يجمع المعلومات (سحب جميع رموز القسيمة)

PUT – تحديث أجزاء من البيانات (تحديث تسعير المنتج)

POST – الإنشاء (إنشاء فئة منتج جديدة)

حذف - (حذف مشاركة مدونة)

ما هو JSON ولماذا يتم استخدامه؟

يتم استخدام JSON (JavaScript Object Notation) لتمثيل البيانات الموجودة على الخادم. من السهل إلى حد ما قراءتها من قبل البشر، ومن السهل على الآلات/التطبيقات فهمها. دعونا نلقي نظرة على مثال JSON من منتج على BigCommerce:

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

ما هو طلب API؟

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

ما هي نقطة النهاية؟

هناك جزأين رئيسيين لنقطة النهاية يتم استخدامهما عند تقديم طلب API. واحد منها هو عنوان URL. يستخدم BigCommerce https://api.bigcommerce.com/stores/ كعنوان URL لجميع طلبات واجهة برمجة التطبيقات. قد يبدو هذا كعنوان URL عادي، ولكن إذا قمت بتوصيله بمتصفح ويب، فستتلقى رسالة خطأ 404.

الجزء الثاني هو المسار. سيختلف المسار اعتمادًا على ما تحاول تحقيقه. يمكنك العثور على قائمة بالمسارات المتاحة لـ BigCommerce من خلال زيارة وثائق المطورين لدينا: https://developer.bigcommerce.com/api-reference. في هذا المثال سنستخدم مسار المنتج وهو /v3/catalog/products.

عندما نجمع هذين الجزأين معًا، نحصل على نقطة نهاية كاملة https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. الآن ربما تقول لنفسك "ما هو {store_hash}؟" "من أين جاء هذا؟" وهذا ما يعرف بالمتغير. تعد المتغيرات مكونات فريدة لنقطة النهاية وستختلف وفقًا لمعلومات متجرك. يمكنك اكتشاف المتغير من خلال القوسين المفتوح والمغلق "{ }".

ما هو الرأس؟

توفر الرؤوس المعلومات للعميل والخادم. من الأمثلة الشائعة للرأس بيانات اعتماد المصادقة مثل "Auth Token" أو "Client ID". يتم توفير بيانات الاعتماد هذه لك تلقائيًا عند إنشاء حساب API. يُشار إلى رأس شائع آخر باسم "نوع المحتوى"، والذي يُعلم الخادم بنوع المحتوى الذي سيتم إرساله. على سبيل المثال، نوع المحتوى الشائع الاستخدام هو "application/json" والذي يتيح للخادم معرفة أننا نرسل بيانات JSON عبرها.

ما هي الطريقة؟

الأساليب هي الإجراءات المتخذة عند إرسال الطلب. فكر في العودة إلى البداية عندما ناقشنا عمليات GET وPUT وPOST وDELETE. هذه كلها طرق API.

ما هي البيانات؟

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

المزيد هنا.