الاتصال بواجهات برمجة التطبيقات بدون رمز: 8 خطوات
الاتصال بواجهات برمجة التطبيقات بدون رمز: 8 خطوات
Anonim
الاتصال بواجهات برمجة التطبيقات بدون رمز
الاتصال بواجهات برمجة التطبيقات بدون رمز

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

إذا كان هذا يبدو مثلك ، فأنت محظوظ! نحن هنا لشرح كيفية العمل مع واجهات برمجة التطبيقات ، وكيفية قراءة مستندات API ، وكيفية استخدام البيانات التي تعود من واجهة برمجة التطبيقات.

لقد أحضرنا صديقًا لنجعل الرحلة أسهل كثيرًا.

قابل سلاش

Slash هو كلب ميشيل المحبوب والرائع (في الصورة أعلاه). ميشيل مهندسة برمجيات تقوم ببناء واجهات برمجة التطبيقات. تستمتع ميشيل بعملها حقًا وقد استلهمت من عملها في بناء واجهات برمجة التطبيقات في تدريب Slash.

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

الخطوة 1: حدد API الذي تحتاجه

ما المعلومات التي تبحث عنها أو تريد تغييرها؟

هل تحاول الحصول على جميع منشورات @ dougthepug على Instagram؟ ربما تريد أن تغرد تلقائيًا لأي شخص يتابع تغريد كلبك (لأنه على الرغم من أن الكلاب لا تستطيع التحدث ، إلا أن لديها الكثير لتقوله ، ونحن نعلم أن Slash متأكد من ذلك).

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

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

الخطوة 2: ابحث عن مستندات API

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

للعثور على هذه الوثائق ، ابحث عن "[إدراج شركة] وثائق API" أو "مطور [إدراج شركة]" على Google.

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

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

إذا كانت واجهة برمجة التطبيقات التي تريد الاتصال بها غير معروفة جيدًا (مثل Slash) ، فقد تحتاج إلى مطالبة المطور بالتوثيق. قد يكون لديهم ملف PDF يحتوي على المعلومات التي تحتاجها أو وثائق عبر الإنترنت غير مدرجة في موقع الويب الخاص بهم.

إذا فاتك الرابط في الخطوة السابقة ، فيمكن العثور على مستندات Slash's API هنا.

الخطوة 3: ابحث عن نقطة النهاية

ابحث عن نقطة النهاية
ابحث عن نقطة النهاية

قد تبدو مستندات API شاقة ، ولكن بمجرد أن تعرف ما الذي تبحث عنه فإنها عادة ما تكون منظمة بشكل جيد وموحدة إلى حد كبير.

أول شيء يجب البحث عنه هو نقطة (نقاط) النهاية المناسبة. يجب أن تكون هناك نقطة نهاية واحدة مطابقة لكل نوع من البيانات التي تريدها. يمكن أن تبدو نقطة النهاية كما يلي:

slashtheapidog.com/api/bones/{id}

أو فقط

/ عظام

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

من مستنداته ، هذه هي نقاط النهاية في واجهة برمجة تطبيقات Slash المتعلقة بالثغرات:

احصل على

احصل على

انشر

ضع

انشر

الخطوة 4: تحديد نوع الطلب الخاص بك

حدد نوع الطلب الخاص بك
حدد نوع الطلب الخاص بك

الآن بعد أن عثرت على نقطة النهاية الصحيحة ، تحتاج إلى تحديد نوع الطلب لإرسالها.

هناك 4 أنواع مختلفة من الطلبات:

احصل على

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

بريد

طلب POST هو كيفية إخبار API بإنشاء شيء جديد. هذا مشابه لمطالبة Slash بحفر (إنشاء) حفرة جديدة لك.

وضع

طلب PUT هو كيفية إخبار API بتحديث شيء تم إنشاؤه مسبقًا. هذا مشابه لمطالبة Slash بالحفر أعمق (التحديث) في الحفرة التي حفرها.

حذف

طلب الحذف هو كيفية إخبار واجهة برمجة التطبيقات بحذف شيء تم إنشاؤه مسبقًا. يشبه هذا مطالبة Slash بالتستر على (حذف) حفرة حفرها سابقًا.

فكر في هذه الأنواع الأربعة. هل تحصل على معلومات ، أو تنشئ إدخالًا جديدًا ، أو تغير إدخالًا موجودًا ، أو تحذف واحدًا؟ تخبرك هذه الإجابة بالضبط بنوع الطلب الذي تحتاجه.

الخطوة الخامسة: فهم المعلمات

افهم المعلمات
افهم المعلمات

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

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

قد تبدو معلمات واجهة برمجة تطبيقات Slash شيئًا مثل هذا لاسترداد الكرات:

احصل على

الخطوة 6: تنسيق طلبك

تنسيق طلبك
تنسيق طلبك
تنسيق طلبك
تنسيق طلبك

لدينا كل المعلومات التي نحتاجها ، والآن نحتاج فقط إلى تقديم الطلب!

فيما يلي طريقتان مختلفتان للاتصال بواجهة برمجة تطبيقات لا تتطلب أي رمز. دعنا نتصل بواجهة برمجة تطبيقات Slash للحصول على قائمة الكرات الخاصة به عن طريق تقديم طلب GET إلى

القطع المكافئ - إذا كنت تريد الاتصال بالبيانات والعمل معها بدون رمز

Parabola هو تطبيق ويب يسمح لك بالاتصال بسهولة بواجهات برمجة التطبيقات ثم التعامل مع البيانات من خلال أداة بصرية تعمل بالسحب والإفلات.

موصى به: