Наостанок

Вступ до API в Python

Chris Ramakers

Engineering Manager

Основи API

Роль API
Типи API
Компоненти URL
Будова запитів і відповідей
Дієслова HTTP

API з Python

Пакет Requests

import requests

HTTP-методи

# Читання ресурсу
requests.get('https://api.my-music.com')
# Створення ресурсу
requests.post('https://api.my-music.com', data={...})
# Оновлення ресурсу
requests.put('https://api.my-music.com', data={...})
# Видалення ресурсу
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