אימות
כל בקשה ל-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"תמונות לא צריכות מפתח
כתובות תמונות ב-img.amodb.dev פומביות. אל תוסיפו להן את המפתח: תג <img> יחשוף אותו לכל מבקר.
שמרו מפתחות בצד השרת
מפתח בחבילת דפדפן, באפליקציית מובייל או במאגר ציבורי הוא מפתח ציבורי. מי שמעתיק אותו מבזבז את קצב הבקשות שלכם. קראו ל-amodb מהשרת שלכם, מפונקציה ללא שרת או משלב בנייה, והעבירו ללקוחות רק את הנתונים.
- שמרו את המפתח במשתנה סביבה או במנהל סודות.
- השתמשו במפתח אחד לכל אפליקציה או סביבה, עם תווית כמו
productionאוstaging. - מחקו מפתח ברגע שהוא דולף. קריאות איתו נכשלות מיד.
שגיאות
| HTTP | status_code | משמעות |
|---|---|---|
| 401 | 7 | המפתח חסר, פגום או לא מוכר. |
| 401 | 10 | המפתח מושעה. כתבו אל support@amodb.dev. |
| 402 | 36 | תוקף המסלול שלכם פג. שלמו עבור תקופה חדשה בעמוד התמחור. |
ראו שגיאות לכל הקודים.