Поиск по внешнему ID

Поиск проекта по внешнему ID

GET /3/find/{external_id} принимает ID из другой системы и возвращает подходящие записи. В пути находится ID, а параметр запроса external_source указывает, из какой системы он взят. amodb принимает двенадцать источников, и семь из них находят записи: imdb_id, tvdb_id, wikidata_id, kinopoisk_id, facebook_id, twitter_id и instagram_id.

Пример сопоставляет ID IMDb tt0137523 с ID TMDB.

curl -sf "https://api.amodb.dev/3/find/tt0137523?external_source=imdb_id" \
  -H "Authorization: Bearer $AMODB_KEY"

const url = 'https://api.amodb.dev/3/find/tt0137523?external_source=imdb_id';
const res = await fetch(url, { headers: { Authorization: `Bearer ${process.env.AMODB_KEY}` } });
if (!res.ok) throw new Error(`amodb returned ${res.status}`);
const found = await res.json();
const movie = found.movie_results[0];
console.log(movie ? `${movie.id} ${movie.title}` : 'no match');

import os
import requests

r = requests.get(
    "https://api.amodb.dev/3/find/tt0137523",
    params={"external_source": "imdb_id"},
    headers={"Authorization": f"Bearer {os.environ['AMODB_KEY']}"},
    timeout=10,
)
r.raise_for_status()
results = r.json()["movie_results"]
print(f"{results[0]['id']} {results[0]['title']}" if results else "no match")

<?php
$url = 'https://api.amodb.dev/3/find/tt0137523?external_source=imdb_id';
$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");
}
$movies = json_decode($body, true)['movie_results'];
echo $movies ? $movies[0]['id'] . ' ' . $movies[0]['title'] : 'no match', PHP_EOL;

package main

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

type Found struct {
	MovieResults []struct {
		ID    int    `json:"id"`
		Title string `json:"title"`
	} `json:"movie_results"`
}

func main() {
	url := "https://api.amodb.dev/3/find/tt0137523?external_source=imdb_id"
	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 f Found
	if err := json.NewDecoder(res.Body).Decode(&f); err != nil {
		panic(err)
	}
	if len(f.MovieResults) == 0 {
		fmt.Println("no match")
		return
	}
	fmt.Println(f.MovieResults[0].ID, f.MovieResults[0].Title)
}

Параметры

• external_idпутьобязателен
  ID в другой системе, например tt0137523.
• external_sourceстрока запросаобязателен
  Одно из значений imdb_id, tvdb_id, wikidata_id, kinopoisk_id, facebook_id, twitter_id, instagram_id. Еще пять значений принимаются, но ничего не возвращают: freebase_mid, freebase_id, tvrage_id, tiktok_id, youtube_id.
• languageстрока запроса
  Один из 14 языков, например en или ru-RU. Другие значения заменяются на en.
• api_keyстрока запросаодин из двух
  Ваш ключ. Используйте его или заголовок Authorization: Bearer.

Если external_source отсутствует или его нет в списке, эндпоинт отвечает 400 со status_code 22. Значение должно быть в нижнем регистре.

Поля ответа

Пример ответа

{
  "movie_results": [
    {
      "adult": false,
      "backdrop_path": "/c6OLXfKAk5BKeR6broC8pYiCquX.jpg",
      "genre_ids": [18, 53],
      "id": 550,
      "original_language": "en",
      "original_title": "Fight Club",
      "overview": "A ticking-time-bomb insomniac and a slippery soap salesman channel primal male aggression into a shocking n...",
      "popularity": 39.0054,
      "poster_path": "/jSziioSwPVrOy9Yow3XhWIBDjq1.jpg",
      "release_date": "1999-10-15",
      "title": "Fight Club",
      "video": false,
      "vote_average": 8.437,
      "vote_count": 33039,
      "media_type": "movie"
    }
  ],
  "person_results": [],
  "tv_results": [],
  "tv_episode_results": [],
  "tv_season_results": []
}

Описание сокращено.

Какой источник что находит

Одно имя аккаунта может соответствовать нескольким проектам. Например, instagram_id=breakingbad возвращает сериал и фильм El Camino, поэтому читайте каждый массив.

curl -sf "https://api.amodb.dev/3/find/361?external_source=kinopoisk_id" \
  -H "Authorization: Bearer $AMODB_KEY"

Внешние ID известного проекта

Обратное направление обеспечивает набор эндпоинтов external_ids. Они возвращают ID, которые другие системы используют для записи, уже имеющейся у вас.

ID, которого у проекта нет, возвращается как null. kinopoisk_id это строка, и она есть у фильма или сериала только тогда, когда amodb ее знает. Реальный ответ для /3/movie/550/external_ids:

{
  "id": 550,
  "imdb_id": "tt0137523",
  "wikidata_id": "Q190050",
  "facebook_id": "FightClub",
  "instagram_id": null,
  "twitter_id": null,
  "kinopoisk_id": "361"
}

Реальный ответ для /3/tv/1396/external_ids:

{
  "id": 1396,
  "imdb_id": "tt0903747",
  "freebase_mid": null,
  "freebase_id": null,
  "tvdb_id": 81189,
  "tvrage_id": null,
  "wikidata_id": "Q1079",
  "facebook_id": "BreakingBad",
  "instagram_id": "breakingbad",
  "twitter_id": "BreakingBad",
  "kinopoisk_id": "404900"
}

Эндпоинты external_ids для сезонов и серий существуют, но все ID в них сейчас равны null, поэтому их можно пропустить.

Факты Wikidata

GET /3/movie/{movie_id}/wikidata и GET /3/tv/{tv_id}/wikidata возвращают ID Wikidata проекта и факты о нем: деньги, соседние части серии, страницы Википедии, награды и места. Все ключи присутствуют всегда. Неизвестный факт равен null для одиночного значения и [] для списка.

Это ответ для Fight Club (фильм 550), сокращенный до читаемого размера:

{
  "id": 550,
  "wikidata_id": "Q190050",
  "budget": {
    "value": 63000000,
    "currency": "USD"
  },
  "box_office": {
    "value": 101209702,
    "currency": "USD",
    "worldwide": true
  },
  "follows": null,
  "followed_by": null,
  "sitelinks": {
    "en": "Fight Club",
    "ru": "Бойцовский клуб (фильм)",
    "uk": "Бійцівський клуб (фільм)"
  },
  "awards": [
    {
      "wikidata_id": "Q28044798",
      "label": "Empire Awards, UK for best british actress"
    },
    {
      "wikidata_id": "Q943908",
      "label": "Jupiter Award",
      "year": 2000
    }
  ],
  "nominations": [
    {
      "wikidata_id": "Q488645",
      "label": "Academy Award for Best Sound Editing",
      "year": 2000
    }
  ],
  "based_on": [
    {
      "wikidata_id": "Q837283",
      "label": "Fight Club",
      "author": {
        "wikidata_id": "Q268181",
        "label": "Chuck Palahniuk"
      }
    }
  ],
  "filming_locations": [
    {
      "wikidata_id": "Q65",
      "label": "Los Angeles"
    }
  ],
  "narrative_locations": [
    {
      "wikidata_id": "Q65",
      "label": "Los Angeles"
    }
  ],
  "original_broadcasters": []
}

В объекте sitelinks 14 записей, а в awards 5. Здесь оба сокращены.

Ссылка содержит wikidata_id, label и, если элемент является проектом из каталога, tmdb_id и media_type. Для The Matrix Reloaded (фильм 604) соседние части это ссылки на фильмы 603 и 605:

{
  "follows": {
    "wikidata_id": "Q83495",
    "label": "The Matrix",
    "tmdb_id": 603,
    "media_type": "movie"
  },
  "followed_by": {
    "wikidata_id": "Q207536",
    "label": "The Matrix Revolutions",
    "tmdb_id": 605,
    "media_type": "movie"
  }
}

Каждый label приходит на языке language из запроса, а при его отсутствии на английском. При language=ru автор выше выглядит как Чак Паланик.

Ошибки

Ошибки используют тело TMDB, например {"success": false, "status_code": 7, "status_message": "Invalid API key: You must be granted a valid key."}.

Неизвестный внешний ID в find не считается ошибкой: ожидайте пять пустых массивов. Эндпоинты external_ids для неизвестного ID тоже не отвечают 404. Они отвечают 200, а все ID равны null. См. ошибки и аутентификация.

Практические замечания

• Сохраняйте ID TMDB при первом разрешении внешнего ID. Следующие вызовы пропускают find и сразу идут на путь сведений, что экономит один запрос на проект.
• Всегда проверяйте, что в нужном массиве есть запись. find может вернуть сразу несколько массивов для одного ID.
• Сведения и внешние ID кэшируются на edge-серверах на 6 часов. Повторный поиск в течение этого времени возвращает сохраненный ответ.
• wikidata_id работает в обе стороны: передайте его в find, чтобы получить проект, или прочитайте из external_ids, чтобы сослаться на внешний ресурс.
• Чтобы перенести поиск по IMDb в стиле OMDb, см. эндпоинт OMDb. Об оценках после поиска проекта читайте на странице рейтинги.