Итоги

Введение в API на Python

Chris Ramakers

Engineering Manager

Основы API

Роль API
Типы API
Компоненты URL
Структура запросов и ответов
HTTP-методы

API и Python

Пакет Requests

import requests

HTTP-методы

# Read a resource
requests.get('https://api.my-music.com')
# Create a resource
requests.post('https://api.my-music.com', data={...})
# Update a resource
requests.put('https://api.my-music.com', data={...})
# Delete a resource
requests.delete('https://api.my-music.com')

Параметры URL

query_params = {'artist': 'Deep Purple'}
requests.get('http://api.my-music.com', params=query_params)

Заголовки

headers = {'accept': 'application/json'}
response = requests.get('http://api.my-music.com', headers=headers)
print(response.headers.get('content-type'))

Коды состояния

response = requests.get('http://api.my-music.com')
print(response.status_code)

Продвинутые темы

Аутентификация
- Базовая аутентификация
```
headers = {'Authorization':'Basic am9obkBleGF...'}
```
- Аутентификация по ключу/токену API
```
headers = {'Authorization': 'Bearer faaa1c9f4...'}
```

Структурированные данные

Запрос данных в формате JSON

requests.get('https://api.my-music.com', headers={'accept': 'application/json'})

Отправка данных в формате JSON

playlists = [{"Name":"My favorite songs"}, {"Name":"Road Trip"}]
requests.post('https://api.my-music.com/playlists/', json=playlists)

Обработка ошибок

Типы ошибок
- Ошибки соединения
- HTTP-ошибки
  - 4XX — ошибки клиента
  - 5XX — ошибки сервера
Обработка ошибок по кодам состояния
- response.status_code
Обработка ошибок с помощью исключений
- raise_for_error()

import requests
from requests.exceptions import ConnectionError, HTTPError

try:
    response = requests.get("http://api.music-catalog.com/albums") 
    response.raise_for_status()

except ConnectionError as conn_err: 
    print(f'Connection Error! {conn_err}.')

except HTTPError as http_err:
    print(f'HTTP error occurred: {http_err}')

Поздравляем!

Введение в API на Python