مقدمة إلى التعامل مع واجهات API

تتيح واجهات برمجة التطبيقات (APIs) للتطبيقات التواصل مع بعضها. وتسهّل مكتبة requests في Python التفاعل مع واجهات API من خلال إرسال طلبات HTTP ومعالجة الاستجابات.

في هذا الدرس، ستتعلّمون كيفية استخدام مكتبة requests لإرسال طلبات API ومعالجة الاستجابات.

تثبيت requests

لتثبيت مكتبة requests، استخدموا الأمر التالي في الطرفية:

pip install requests

بعد التثبيت، يمكنكم استيرادها في نصوص Python البرمجية:

# Importing requests
import requests

print("Requests library imported successfully")

إرسال طلب GET

تُستخدم الطريقة GET لاسترداد البيانات من واجهة API. استخدموا الدالة requests.get() لإرسال طلب GET:

# Sending a GET request
import requests

response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
print(response.json())  # Outputs the JSON response

إرسال طلب POST

تُستخدم طريقة POST لإرسال البيانات إلى واجهة API. استخدموا الدالة requests.post():

# Sending a POST request
import requests

payload = {"title": "foo", "body": "bar", "userId": 1}
response = requests.post("https://jsonplaceholder.typicode.com/posts", json=payload)
print(response.json())  # Outputs the response

معالجة الاستجابات

توفر مكتبة requests عدة سمات لمعالجة الاستجابات، منها:

• response.status_code: رمز حالة HTTP.
• response.json(): بيانات استجابة JSON.
• response.text: المحتوى الخام للاستجابة.

# Handling responses
response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Failed with status code:", response.status_code)

إضافة معلمات الاستعلام

يمكنكم تمرير معلمات الاستعلام إلى واجهات API باستخدام الوسيط params في طلب GET:

# Adding query parameters
params = {"userId": 1}
response = requests.get("https://jsonplaceholder.typicode.com/posts", params=params)
print(response.json())

إضافة الترويسات

تتيح الترويسات إرسال معلومات إضافية، مثل مفاتيح API أو أنواع المحتوى، مع طلباتكم:

# Adding headers
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get("https://jsonplaceholder.typicode.com/posts", headers=headers)
print(response.status_code)

معالجة الأخطاء

توفر مكتبة requests معالجة مضمّنة للاستثناءات المتعلقة بالشبكة:

# Handling errors
try:
    response = requests.get("https://jsonplaceholder.typicode.com/invalid")
    response.raise_for_status()
except requests.exceptions.HTTPError as err:
    print("HTTP error occurred:", err)
except requests.exceptions.RequestException as err:
    print("Request error occurred:", err)

الأخطاء الشائعة عند استخدام requests

إليك بعض الأخطاء التي يجب تجنبها:

• عدم معالجة أخطاء HTTP باستخدام response.raise_for_status().
• تضمين معلومات حساسة، مثل مفاتيح API، مباشرةً في النص البرمجي.
• نسيان تحديد طريقة HTTP الصحيحة، مثل GET أو POST.

ما الذي تعلّمناه؟

في هذا الدرس، تعلّمتم:

• كيفية تثبيت مكتبة requests واستيرادها.
• كيفية إرسال طلبات GET وPOST إلى واجهات API.
• كيفية معالجة الاستجابات وإضافة معلمات الاستعلام والترويسات ومعالجة الأخطاء.

عمل رائع! لننتقل إلى الموضوع التالي.