ما هي واجهة برمجة تطبيقات REST وكيف يمكنك الحصول على بيانات لتطبيقك أو موقعك الإلكتروني؟

اختصار API لتقف على واجهة برمجة التطبيق. ان API هي مجموعة من الوظائف التي تسهل الاتصال بين تطبيقين برمجيين. في الأساس ، يعد ملف API يأخذ طلبًا من تطبيق برمجي إلى آخر ، ثم يعود إلى برنامج البدء مع الاستجابة المناسبة.

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

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

كيف تعمل واجهة برمجة تطبيقات REST؟

أ REST API يصل إلى البيانات من خلال معرفات الموارد الموحدة (URIs) ، وهي سلسلة من الأحرف التي تحدد موردًا معينًا. نوع URI المستخدم بواسطة ملف REST API هو محدد موقع الموارد (URL).

للوصول إلى الموارد ومعالجتها ، فإن REST API يستخدم أفعال الطلب التالية:

• الحصول على (يستخدم هذا للحصول على البيانات من قاعدة بيانات)
• نشر (إضافة بيانات جديدة إلى قاعدة بيانات)
• ضع (تحديث البيانات في قاعدة بيانات)
• حذف (حذف البيانات من قاعدة بيانات)

إذا كنت ترغب في الاستفادة من خدمات واحدة من العديد واجهات برمجة تطبيقات REST متاحًا على الويب (بدلاً من إنشاء واحد من البداية) ، سيكون لديك فقط حق الوصول إلى فعل طلب الحصول على REST API (من خلال URL). تحتوي عناوين URL هذه على العديد من المكونات ، ولكن المكونات التي تحتاج إلى معرفتها هي API المفتاح والاستعلام.

ال API key هو معرّف فريد ستتلقاه بمجرد التسجيل في ملف REST API برنامج. عادة ما يكون الاستعلام معادلة بسيطة تستخدم لتخصيص بحثك. لذلك ، إذا كنت ترغب في معرفة الطقس الحالي في مدينة نيويورك ، فقد يكون قسم الاستعلام في عنوان URL الخاص بك هو "city = New York".

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

استخدام تطبيق JavaScript للحصول على البيانات من باقي واجهات برمجة التطبيقات (API) المختلفة

لإنشاء هذا التطبيق البسيط ، هناك تطبيقان برمجيان آخران تحتاج إلى تثبيتهما على جهاز الكمبيوتر الخاص بك: NodeJS و npm. لقد كتبنا مقالًا عن كيفية التثبيت NodeJS و npm على Ubuntu، بالإضافة إلى واحد في كيفية القيام بذلك على Windows—لذلك تحقق من هؤلاء إذا كنت تريد معرفة المزيد.

بعد تثبيت التطبيقات المذكورة أعلاه على جهاز الكمبيوتر ، ستحتاج إلى اتباع الخطوات التالية:

1. افتح IDE الخاص بك وقم بتشغيل المحطة.
2. انتقل إلى المجلد الذي يحتوي على ملف تطبيق JavaScript الخاص بك باستخدام الأمر cd.
3. قم بتهيئة npm باستخدام سطر التعليمات البرمجية التالي:

npm الحرف الأول

هناك وحدة npm واحدة ستلعب دورًا رئيسيًا في وظائف هذا التطبيق. هذه هي وحدة got ، وهي مكتبة طلبات HTTP لـ NodeJS. سيقوم سطر التعليمات البرمجية التالي بتثبيت أحدث إصدار من مكتبة got في ملفات التطبيق الخاص بك:

حصل تثبيت npm على @ الأحدث

الآن يمكنك المضي قدمًا وبناء التطبيق الخاص بك.

استخدام مكتبة Got Library لبناء تطبيقك

// استيراد المكتبة التي حصلت عليها في التطبيق الخاص بك
حصلت على const = تتطلب ('حصلت') ؛
// إحضار البيانات من واجهة برمجة تطبيقات REST محددة وطباعة جسمها على الجهاز
(غير متزامن () => {
محاولة {
استجابة const = انتظر حصلت (URL) ؛
بيانات const = JSON.parse (response.body) ؛
console.log (البيانات) ؛
} catch (خطأ) {
console.log (error.data) ؛
}
})();

سيحصل التطبيق أعلاه على البيانات من أي ملف REST API على الويب. ومع ذلك ، ستحتاج إلى تقديم عنوان URL للمورد ذي الصلة أولاً.

الحصول على البيانات من واجهة برمجة تطبيقات Weather REST

Weatherbit.io API هو أحد أكثر الأحوال الجوية شيوعًا واجهات برمجة تطبيقات REST. إدخال عنوان URL لهذا API في تطبيق JavaScript البسيط أعلاه سيجعل التطبيق جاهزًا للعمل.

استخدام واجهة برمجة تطبيقات Weatherbit.io REST

// استيراد المكتبة التي حصلت عليها في التطبيق الخاص بك
حصلت على const = تتطلب ('حصلت') ؛
// إحضار البيانات من واجهة برمجة تطبيقات REST محددة وطباعة جسمها على الجهاز
(غير متزامن () => {
محاولة {
عنوان URL لـ const = ' https://api.weatherbit.io/v2.0/current? خط العرض = 40.7128 & lon = -74.0060 & key = API_KEY '؛
استجابة const = انتظر حصلت (URL) ؛
بيانات const = JSON.parse (response.body) ؛
console.log (البيانات) ؛
} catch (خطأ) {
console.log (error.data) ؛
}
})();

عنوان URL لموقع Weatherbit.io API تم إدخاله الآن بنجاح في التطبيق. ومع ذلك ، هناك جانب واحد من عنوان URL تحتاج إلى تعديله لتشغيل التطبيق. هذا هو القسم المسمى "API_KEY" ، وهذا المفتاح هو ما ستحصل عليه من Weatherbit.io عند التسجيل للحصول على حساب مجاني.

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

لمزيد من المعلومات حول كيفية استخدام Weatherbit.io REST API, انقر هنا.

بعد إدخال ملف API في القسم ذي الصلة أعلاه ، يمكنك الآن تنفيذ ملف JavaScript الخاص بك. سيوفر التطبيق شيئًا مشابهًا للإخراج التالي في جهازك.

مثال على استجابة Weatherbit.io REST API

البيانات: [
{
rh: 53 ،
جراب: 'd'،
lon: -74.01 ،
العرض: 1005.9 ،
المنطقة الزمنية: "America / New_York" ،
ob_time: "2021-09-27 14:50" ،
country_code: "US"،
السحب: 25،
ts: 1632754200 ،
solar_rad: 652.8 ،
state_code: "NY"،
city_name: "مدينة نيويورك" ،
wind_spd: 5.66 ،
wind_cdir_full: "الغرب - الجنوب الغربي" ،
wind_cdir: "WSW" ،
slp: 1015.9 ،
فيس: 5 ،
h_angle: -30 ،
غروب الشمس: '22: 44 '،
دني: 851.72 ،
الندى: 12،
الثلج: 0 ،
الأشعة فوق البنفسجية: 5.68859 ،
هطول: 0 ،
wind_dir: 240 ،
شروق الشمس: '10: 49 '،
ghi: 657.55 ،
دبي: 106.79 ،
عقي: 53 ،
خط العرض: 40.71 ،
الطقس: [كائن] ،
التاريخ والوقت: "2021-09-27: 14"،
درجة الحرارة: 22 ،
المحطة: 'KJRB' ،
الارتفاع_انجل: 40.89 ،
app_temp: 21.7
}
],
العد: 1
}

تتضمن بعض الجوانب الأكثر أهمية للبيانات التي يتم إرجاعها في الاستجابة ما يلي:

• اسم المدينة (تعرض اسم المدينة عند خط الطول وخط العرض المقدمين).
• التاريخ والوقت (تُرجع ساعة الدورة الحالية بالتنسيق YYYY-MM-DD: HH).
• طقس (يُرجع كائنًا يحتوي على رمز الطقس ورمز الطقس ووصفًا نصيًا للطقس).

الحصول على البيانات من واجهة برمجة تطبيقات News REST

الاخبار API المستخدم في هذا القسم هو Newsdata.io. مثل جميع واجهات برمجة تطبيقات REST على الويب ، فإنه يوفر العديد من خيارات الاستعلام ، والتي يمكنك استخدامها لاسترداد الأخبار العاجلة من جميع أنحاء العالم. مع Newsdata.io API، يمكنك الحصول على أخبار من بلد معين ، أو بلغة أو فئة معينة ، وما إلى ذلك.

باستخدام تطبيق JavaScript ، يمكنك استرداد البيانات من الأخبار REST API. ما عليك سوى استبدال عنوان URL في التطبيق أعلاه بعنوان URL التالي:

' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '

الخطوة التالية هي استبدال قسم "YOUR_API_KEY" في عنوان URL أعلاه بامتداد API المفتاح الذي ستتلقاه بعد التسجيل في Newsdata.io. سيعرض عنوان URL أعلاه الأخبار العاجلة من أمريكا. ومع ذلك ، إذا كنت تريد أخبارًا من اليابان ، يمكنك ببساطة استبدال الاستعلام "contry = us" بـ "country = jp".

لمزيد من المعلومات حول كيفية استخدام Newsdata.io REST API, انقر هنا.

متعلق ب: هل تريد إضافة عناوين الأخبار إلى موقع الويب أو التطبيق الخاص بك؟ أنت بحاجة إلى Mediastack API

مثال على استجابة Newsdata.io REST API

{
العنوان: قُتل سائق من باب سيارته أثناء انتظاره في الطابور في Fast-Food Drive-Thru ، مما يوفر رؤى تحذيرية للسيارات ذاتية القيادة بالذكاء الاصطناعي ،
حلقة الوصل: ' https://www.forbes.com/sites/lanceeliot/2021/09/27/driver-killed-by-his-own-car-door-while-waiting-in-line-at-fast-food-drive-thru-providing-cautionary-insights-for-ai-self-driving-cars/',
الكلمات الرئيسية: [صفيف] ،
الخالق: [صفيف] ،
video_URL: خالية ،
الوصف: "توفر قصة إخبارية حزينة عن مقتل سائق من باب سيارته (أثناء تواجده في سيارة) إحصاءات تحذيرية حول
ظهور السيارات ذاتية القيادة القائمة على الذكاء الاصطناعي. هذه هي النظرة الداخلية. "،
المحتوى: "توفر قصة إخبارية حزينة عن مقتل سائق من باب سيارته (أثناء تواجده في سيارة) رؤى تحذيرية حول
ظهور السيارات ذاتية القيادة القائمة على الذكاء الاصطناعي. هذه هي النظرة الداخلية. "،
تاريخ النشر: "2021-09-27 15:30:00"،
رابط الصورة: ' https://thumbor.forbes.com/thumbor/fit-in/0x0/filters%3Aformat%28jpg%29/https://specials-images.forbesimg.com/imageserve/614272b9f18bec6882652695/0x0.jpg? CropX1 = 23 & CropX2 = 2455 & CropY1 = 23 & CropY2 = 1538 '،
source_id: "فوربس"
}

استخدام تطبيق Python للحصول على البيانات من واجهات برمجة تطبيقات أخرى للراحة

من الممكن الحصول على بيانات لموقعك على الويب أو تطبيقك باستخدام أي لغة برمجة مألوفة لك. لذلك ، إذا كنت لا تريد استخدام JavaScript ، يمكنك تحقيق نفس النتائج باستخدام تطبيق Python.

متعلق ب: كيفية بناء واجهات برمجة التطبيقات في بايثون: الأطر الشائعة

كل ما عليك فعله هو تثبيت طلبات HTTP python module باستخدام بيئة pip. بعد ذلك ، يمكنك إنشاء تطبيق Python الخاص بك باستخدام الكود التالي:

# استيراد مكتبة الطلبات
طلبات الاستيراد
# الحصول على البيانات باستخدام مكتبة الطلبات
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = لنا '
res = request.get (URL)
json = res.json ()
للمفتاح في json:
طباعة (مفتاح ، json [مفتاح])

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

الحصول على البيانات الخاصة بموقعك أو تطبيقك أمر بسيط للغاية

لديك الآن الأدوات التي تحتاجها للحصول على البيانات لتطبيقات البرامج الخاصة بك. من المهم أن تتذكر أن استراحة تسهل الهندسة المعمارية الاقتران السائب ، مما يعني أنه يمكنك استخدام أي لغة برمجة للحصول على البيانات من أي لغة REST API على الويب.

الآن أنت تعرف كيفية الاستخدام بقية API، لما لا تعطها محاولة؟

تجريف الويب مقابل. API: ما هي أفضل طريقة لاستخراج البيانات؟

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

اقرأ التالي

نبذة عن الكاتب