Аўтэнтыфікацыя
Кожны запыт да 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"Выявам ключ не патрэбны
URL выяў на img.amodb.dev публічныя. Не дадавайце да іх свой ключ: тэг <img> выставіць яго напаказ кожнаму наведвальніку.
Трымайце ключы на серверы
Ключ у бандле браўзера, мабільнай праграме або публічным рэпазітары з’яўляецца публічным. Любы, хто яго скапіруе, будзе расходаваць ваш ліміт запытаў. Выклікайце amodb са свайго сервера, serverless-функцыі або з кроку зборкі, а кліентам перадавайце толькі даныя.
- Захоўвайце ключ у зменнай асяроддзя або ў менеджары сакрэтаў.
- Выкарыстоўвайце адзін ключ на праграму або асяроддзе з меткай, напрыклад
productionабоstaging. - Выдаляйце ключ у той жа момант, калі ён уцёк. Выклікі з ім перастаюць працаваць адразу.
Памылкі
| HTTP | status_code | Значэнне |
|---|---|---|
| 401 | 7 | Ключ адсутнічае, мае няправільны фармат або невядомы. |
| 401 | 10 | Ключ прыпынены. Напішыце на support@amodb.dev. |
| 402 | 36 | Тэрмін вашага плана скончыўся. Аплаціце новы перыяд на старонцы з цэнамі. |
Усе коды гл. на старонцы памылкі.