Введение в работу с API

API (программные интерфейсы приложений) позволяют приложениям обмениваться данными. Библиотека Python requests упрощает взаимодействие с API: с её помощью можно отправлять HTTP-запросы и обрабатывать ответы.

В этом уроке Вы узнаете, как использовать библиотеку requests для отправки запросов к API и обработки ответов.

Установка requests

Чтобы установить библиотеку requests, выполните в терминале следующую команду:

pip install requests

После установки Вы сможете импортировать её в свои скрипты Python:

# Importing requests
import requests

print("Requests library imported successfully")

Отправка запроса GET

Метод GET используется для получения данных из API. Для отправки GET-запроса используйте функцию requests.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.
• Как обрабатывать ответы, добавлять параметры запроса и заголовки, а также обрабатывать ошибки.

Отличная работа! Теперь перейдём к следующей теме.