Автентифікація
Кожен запит до amodb містить один ключ: 32 шістнадцяткові символи нижнього регістру. Надсилайте його як api_key у запиті або як заголовок Authorization: Bearer для викликів у стилі TMDB і як apikey для викликів у стилі OMDb. Для зображень ключ не потрібен. Хибний ключ повертає 401 зі status_code 7, призупинений ключ повертає 401 зі status_code 10.
Формат ключа
Ключ складається з 32 шістнадцяткових символів нижнього регістру, наприклад 0123456789abcdef0123456789abcdef. Він має ту саму форму, що й ключ TMDB v3, тож поля та валідатори, створені для ключів TMDB, його приймають.
amodb зберігає лише хеш SHA-256 кожного ключа. Повний ключ показується один раз, коли ви його створюєте. Якщо ви його втратили, видаліть його й створіть новий.
Виклики у стилі TMDB
Надішліть ключ одним із двох способів. Обидва працюють на кожному ендпоінті під https:/.
| Спосіб | Приклад |
|---|---|
| Параметр запиту | ?api_key=YOUR_KEY |
| Заголовок | Authorization: Bearer YOUR_ |
curl "https://api.amodb.dev/3/configuration" \
-H "Authorization: Bearer $AMODB_KEY"const res = await fetch("https://api.amodb.dev/3/configuration", {
headers: { Authorization: `Bearer ${process.env.AMODB_KEY}` },
});import os
import requests
res = requests.get(
"https://api.amodb.dev/3/configuration",
headers={"Authorization": f"Bearer {os.environ['AMODB_KEY']}"},
timeout=10,
)<?php
$url = "https://api.amodb.dev/3/configuration?api_key=" . urlencode(getenv("AMODB_KEY"));
$config = json_decode(file_get_contents($url), true);req, _ := http.NewRequest("GET", "https://api.amodb.dev/3/configuration", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("AMODB_KEY"))
res, err := http.DefaultClient.Do(req)Виклики у стилі OMDb
Ендпоінт, сумісний з OMDb, приймає ключ як apikey, так само як OMDb. Це той самий ключ, який ви використовуєте для викликів у стилі TMDB.
curl "https://api.amodb.dev/omdb/?t=Inception&y=2010&apikey=$AMODB_KEY"Зображення не потребують ключа
URL зображень на img.amodb.dev публічні. Не додавайте до них свій ключ: тег <img> відкрив би його кожному відвідувачу.
Зберігайте ключі на сервері
Ключ у збірці для браузера, мобільному застосунку чи публічному репозиторії стає публічним. Будь-хто, хто його скопіює, витрачає ваш ліміт запитів. Викликайте amodb зі свого сервера, безсерверної функції або кроку збірки й передавайте клієнтам лише дані.
- Зберігайте ключ у змінній середовища або менеджері секретів.
- Використовуйте один ключ на застосунок чи середовище, з назвою на кшталт
productionабоstaging. - Видаляйте ключ у ту мить, коли він витік. Виклики з ним одразу перестають працювати.
Помилки
| HTTP | status_code | Значення |
|---|---|---|
| 401 | 7 | Ключ відсутній, має хибний формат або невідомий. |
| 401 | 10 | Ключ призупинено. Напишіть на support@amodb.dev. |
| 402 | 36 | Термін дії вашого тарифу закінчився. Сплатіть новий період на сторінці цін. |
Усі коди дивіться на сторінці помилки.