Работа с API с помощью requests

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

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

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

pip install requests

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

# Importing requests
import requests

print("Requests library imported successfully")

Метод 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 используется для отправки данных в программный интерфейс. Используйте функцию 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)

Вот некоторых ошибок следует избегать:

• Не обрабатывать ошибки протокола передачи гипертекста с помощью response.raise_for_status().
• Жёстко задавать конфиденциальные сведения, например ключи доступа к программному интерфейсу, в скрипте.
• Забывать указывать правильный метод протокола передачи данных (например, GET, POST).

В этом уроке вы научились:

• Устанавливать и импортировать библиотеку requests.
• Отправлять запросы GET и POST к API.
• Обрабатывать ответы, добавлять параметры запросов и заголовки, а также обрабатывать ошибки.

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