API kolekcí

Kolekce seskupuje filmy jedné franšízy, například trilogii nebo dlouhou filmovou sérii. GET /3/collection/{collection_id} vrací její název, popis, obrázky a pole parts s filmy v pořadí vydání. Filmy odkazují zpět na svou kolekci přes belongs_to_collection, takže se můžete pohybovat oběma směry.

Aktualizováno Zobrazit jako Markdown

Získání kolekce

GET /3/collection/{collection_id} vrací jednu franšízu: její název, popis, plakát, pozadí a pole parts. Každá část je souhrn filmu s poli, která potřebujete pro kartu, takže jedno volání vykreslí celou polici franšízy.

Příklad načte kolekci 10, filmy Star Wars, a vypíše její filmy v pořadí vydání.

bashjspyphpgo
curl -s "https://api.amodb.dev/3/collection/10?language=en-US" \
  -H "Authorization: Bearer $AMODB_KEY"
const url = 'https://api.amodb.dev/3/collection/10?language=en-US';
const res = await fetch(url, { headers: { Authorization: `Bearer ${process.env.AMODB_KEY}` } });
if (!res.ok) throw new Error(`amodb returned ${res.status}`);
const collection = await res.json();
console.log(collection.name);
for (const p of collection.parts) console.log(p.release_date || 'not dated', p.title);
import os
import requests

r = requests.get(
    "https://api.amodb.dev/3/collection/10",
    params={"language": "en-US"},
    headers={"Authorization": f"Bearer {os.environ['AMODB_KEY']}"},
    timeout=10,
)
r.raise_for_status()
collection = r.json()
print(collection["name"])
for p in collection["parts"]:
    print(p.get("release_date") or "not dated", p["title"])
<?php
$url = 'https://api.amodb.dev/3/collection/10?language=en-US';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AMODB_KEY')],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status !== 200) {
    throw new RuntimeException("amodb returned $status");
}
$collection = json_decode($body, true);
echo $collection['name'], PHP_EOL;
foreach ($collection['parts'] as $p) {
    echo $p['release_date'] ?: 'not dated', ' ', $p['title'], PHP_EOL;
}
package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
	"time"
)

type Collection struct {
	Name  string `json:"name"`
	Parts []struct {
		Title       string `json:"title"`
		ReleaseDate string `json:"release_date"`
	} `json:"parts"`
}

func main() {
	url := "https://api.amodb.dev/3/collection/10?language=en-US"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("AMODB_KEY"))
	client := &http.Client{Timeout: 10 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode != http.StatusOK {
		panic(res.Status)
	}
	var c Collection
	if err := json.NewDecoder(res.Body).Decode(&c); err != nil {
		panic(err)
	}
	fmt.Println(c.Name)
	for _, p := range c.Parts {
		date := p.ReleaseDate
		if date == "" {
			date = "not dated"
		}
		fmt.Println(date, p.Title)
	}
}

Parametry

  • collection_idpathpovinný
    Číselné ID kolekce, například 10.
  • api_keyqueryjeden ze dvou
    Váš klíč. Použijte jej, nebo hlavičku Authorization: Bearer.
  • languagequery
    Jeden ze 14 podporovaných jazyků, například en-US nebo fr-FR. Nastavuje jazyk názvu a popisu každého filmu. Výchozí en-US.

Vlastní name a overview kolekce přicházejí tak, jak jsou uložené, a s language se nemění. U některých kolekcí nejsou anglicky.

Pole odpovědi

PoleTypPoznámky
idintegerID kolekce.
namestringNázev franšízy.
overviewstringKrátký popis. U některých kolekcí prázdný.
poster_path, backdrop_pathstring nebo nullPřipojte k https://img.amodb.dev/t/p/{size}. Viz obrázky.
partsarraySouhrny filmů, od nejstaršího release_date.
parts[].idintegerID filmu. Předejte jej do detailu filmu.
parts[].title, parts[].original_titlestringLokalizovaný a původní název.
parts[].overviewstringLokalizovaný obsah.
parts[].release_datestringYYYY-MM-DD, nebo prázdný řetězec u filmu bez data. Tyto filmy jsou na konci.
parts[].media_typestringV kolekci vždy movie.
parts[].genre_idsarrayČíselná ID. Názvy jsou na stránce žánry.
parts[].adult, parts[].videobooleanadult je vždy false, protože tituly pro dospělé se neposkytují.
parts[].original_languagestringDvoupísmenný kód jazyka.
parts[].popularitynumberSkóre popularity.
parts[].poster_path, parts[].backdrop_pathstring nebo nullObrázky filmu.
parts[].vote_average, parts[].vote_countnumber, integerSouhrnné skóre uživatelů.

Příklad odpovědi

Zobrazeny jsou dvě z devíti částí.

JSON
{
  "id": 10,
  "name": "Star Wars Collection",
  "overview": "An epic space-opera theatrical film series, which depicts the adventures of various cha...",
  "poster_path": "/pWVLFh4OuejTpUaDQbB1C4zoS2p.jpg",
  "backdrop_path": "/iY2ujEY2m68OTTlPFTiHub9joHS.jpg",
  "parts": [
    {
      "adult": false,
      "backdrop_path": "/zqkmTXzjkAgXmEWLRsY4UpTWCeo.jpg",
      "genre_ids": [12, 28, 878],
      "id": 11,
      "original_language": "en",
      "original_title": "Star Wars",
      "overview": "Princess Leia is captured and held hostage by the evil Imperial forces in their effort...",
      "popularity": 70.481,
      "poster_path": "/fai0rspsNeJCS69wHNjOdWxcI7P.jpg",
      "release_date": "1977-05-25",
      "title": "Star Wars",
      "video": false,
      "vote_average": 8.207,
      "vote_count": 23025,
      "media_type": "movie"
    },
    {
      "adult": false,
      "backdrop_path": "/k9pshruhCpJAdH9RaGJO6jaWQ4X.jpg",
      "genre_ids": [12, 28, 878],
      "id": 1891,
      "original_language": "en",
      "original_title": "The Empire Strikes Back",
      "overview": "The epic saga continues as Luke Skywalker, in hopes of defeating the evil Galactic Empi...",
      "popularity": 29.9034,
      "poster_path": "/nNAeTmF4CtdSgMDplXTDPOpYzsX.jpg",
      "release_date": "1980-05-20",
      "title": "The Empire Strikes Back",
      "video": false,
      "vote_average": 8.393,
      "vote_count": 18990,
      "media_type": "movie"
    }
  ]
}

Dlouhé řetězce jsou na této stránce zkráceny pomocí .... Skutečná odpověď obsahuje celý text.

Najděte kolekci filmu

Zřídka začínáte od ID kolekce. Začínáte od filmu a záznam detailu filmu vám řekne, kam patří. Pole belongs_to_collection je objekt s id, name, poster_path a backdrop_path. Je null u filmu, který není součástí franšízy, například u filmu 550.

JSON
{
  "id": 11,
  "title": "Star Wars",
  "belongs_to_collection": {
    "id": 10,
    "name": "Star Wars Collection",
    "poster_path": "/pWVLFh4OuejTpUaDQbB1C4zoS2p.jpg",
    "backdrop_path": "/iY2ujEY2m68OTTlPFTiHub9joHS.jpg"
  }
}

Ukázka níže sleduje tento odkaz od filmu k jeho franšíze na dva požadavky.

JavaScript
const base = 'https://api.amodb.dev/3';
const headers = { Authorization: `Bearer ${process.env.AMODB_KEY}` };

async function getJson(path) {
  const res = await fetch(`${base}${path}`, { headers });
  if (!res.ok) throw new Error(`${path} returned ${res.status}`);
  return res.json();
}

const movie = await getJson('/movie/11');
if (movie.belongs_to_collection) {
  const collection = await getJson(`/collection/${movie.belongs_to_collection.id}`);
  console.log(movie.title, 'is one of', collection.parts.length, 'films in', collection.name);
}

Obrázky a hledání

Plakát a pozadí franšízy jsou pole poster_path a backdrop_path záznamu kolekce. Adresu souboru z nich sestavte podle stránky obrázky. amodb nenabízí cesty /collection/{collection_id}/images a /collection/{collection_id}/translations, takže kolekce nemá seznam alternativních plakátů ani jazykové řádky. Názvy filmů se místo toho řídí parametrem language a cesty, které jazykové řádky vracejí, pokrývá stránka překlady.

Kolekci podle názvu najdete přes GET /3/search/collection?query=matrix, popsaný na stránce vyhledávání. Každý výsledek má id, name, overview, poster_path, backdrop_path, original_language, original_name a adult.

Chyby

HTTPstatus_codeKdy
4017Klíč chybí nebo je nesprávný.
40236Platnost tarifu skončila.
40434Kolekce s tímto ID neexistuje, nebo ID není číslo.
40537Použili jste metodu pro zápis na cestě kolekce.
42925Překročili jste počet požadavků za minutu. Počkejte tolik sekund, kolik říká Retry-After.

Úplný seznam je na stránce chyby a limity tarifů na stránce limity požadavků.

Praktické poznámky

  • Kolekce seskupují jen filmy. Film má nejvýše jeden objekt belongs_to_collection, takže jeden film patří do jedné franšízy.
  • Filmy přicházejí v pořadí vydání. Filmy s prázdným datem jsou na konci, označte je proto jako zatím bez data.
  • Záznam kolekce se na edge cachuje 6 hodin jako ostatní detaily, takže stránka franšízy může jednu odpověď znovu použít po tuto dobu.
  • Část nese jen souhrnná pole. Délku, obsazení a hodnocení načtěte pro každý film přes detail filmu, když ho uživatel otevře.
  • Jako klíč filmu používejte parts[].id, ne jeho pozici ve franšíze. Pořadí a data se časem opravují.
  • Než zobrazíte name, ověřte, že je ve vašem jazyce zobrazení. Některé kolekce mají název v jiném jazyce a language jej nemění.