Удостоверяване
Всяка заявка към amodb носи един ключ: 32 шестнадесетични знака с малки букви. Изпратете го като api_key в заявката или като заглавка Authorization: Bearer за извиквания в стил TMDB, а за стила OMDb като apikey. Изображенията не изискват ключ. Грешен ключ връща 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"Изображенията не изискват ключ
Адресите на изображенията на img.amodb.dev са публични. Не добавяйте ключа си към тях: тагът <img> би го разкрил на всеки посетител.
Пазете ключовете на сървъра
Ключ в браузърен пакет, мобилно приложение или публично хранилище е публичен. Всеки, който го копира, изразходва скоростта на заявките ви. Викайте amodb от сървъра си, от безсървърна функция или от стъпка на билда и подавайте на клиентите само данните.
- Пазете ключа в променлива на средата или в мениджър на тайни.
- Ползвайте по един ключ за приложение или среда, с етикет като
productionилиstaging. - Изтрийте ключа веднага щом бъде разкрит. Заявките с него се отхвърлят незабавно.
Грешки
| HTTP | status_code | Значение |
|---|---|---|
| 401 | 7 | Ключът липсва, има неправилен формат или е непознат. |
| 401 | 10 | Ключът е спрян. Пишете на support@amodb.dev. |
| 402 | 36 | Планът ви е изтекъл. Платете нов период на страницата с цените. |
Всички кодове са описани на страницата грешки.