مقدمة إلى التعامل مع واجهات 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.
• كيفية معالجة الاستجابات وإضافة معلمات الاستعلام والرؤوس ومعالجة الأخطاء.

أحسنت! لننتقل إلى الموضوع التالي.