Obter chave de API

Tutorial de API de filmes em PHP

Crie uma função PHP reutilizável e uma página de filme simples. A função chama o amodb com cURL, lê o Retry-After em um 429 e guarda cada resposta em um arquivo por 6 horas. A página mostra pôster, elenco e nota do IMDb. Exige PHP 8.2 ou mais novo com a extensão curl e leva cerca de 20 minutos.

.php PHP Atualizado em Ver em Markdown

Você vai criar dois arquivos pequenos. O amodb.php tem uma função, amodb_get(), que chama a API com cURL e guarda as respostas em arquivos. O movie.php é uma página que mostra um filme por id com pôster, elenco e nota do IMDb. Você precisa do PHP 8.2 ou mais novo com a extensão curl e de cerca de 20 minutos.

Passo 1: obtenha uma chave de API

Compre um período pré-pago em preços. Não há plano gratuito, e todo plano retorna o conjunto completo de dados a 20, 40 ou 120 requisições por minuto. Crie uma chave no painel da sua conta. Ela tem 32 caracteres hexadecimais em minúsculas. Exporte-a antes de iniciar o PHP:

O código a lê com getenv('AMODB_KEY'). Sob o PHP-FPM, os workers não enxergam o seu shell, então defina env[AMODB_KEY] na configuração do pool.

Shell 
export AMODB_KEY="YOUR_API_KEY"

Passo 2: prepare o projeto

Crie uma pasta e confira se o cURL está disponível:

O primeiro comando deve informar 8.2 ou superior. O segundo deve imprimir curl.

Shell 
mkdir movie-page && cd movie-page
php -v
php -m | grep -i curl

Passo 3: envie a primeira requisição

Uma chamada cURL simples precisa de quatro coisas: a URL, um timeout, o cabeçalho Authorization e uma checagem de status. No PHP 8 o handle se libera sozinho, então não há curl_close().

PHP 
<?php
$ch = curl_init('https://api.amodb.dev/3/movie/550?language=en-US');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AMODB_KEY')],
]);
$body = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), PHP_EOL;

Passo 4: encapsule em uma função

Chamar o cURL em cada página repete a mesma configuração. amodb_get($path, $query, $ttl) monta a URL com http_build_query, envia a chamada e retorna um array decodificado. A página do filme passa append_to_response=credits,ratings, então elenco e notas chegam na mesma requisição. Os detalhes dos campos estão em filmes, e os tamanhos de pôster estão em imagens.

Passo 5: trate erros e limites de requisições

A função lança AmodbException em toda falha, e a página a captura em um só lugar.

StatusO que a função faz
401Lança a exceção na hora. Uma chave inválida ou suspensa não se resolve tentando de novo.
404Lança a exceção com o status_message, para que a página diga que o id é desconhecido.
429Lê o cabeçalho Retry-After, espera essa quantidade de segundos (de 1 a 30) e tenta de novo até duas vezes.
5xxLança a exceção com o código de status e a mensagem.
Erro do cURLLança Network error com o texto de curl_error().

O cabeçalho chega por CURLOPT_HEADERFUNCTION, um callback que o cURL executa para cada linha de cabeçalho da resposta. Veja erros para a lista completa de códigos.

Passo 6: guarde as respostas em cache de arquivos

A borda guarda os detalhes por 6 horas. Um arquivo local economiza a própria requisição, e um acerto no cache não gasta nada do seu limite. As idades se somam, então um arquivo com 6 horas pode conter dados que já tinham horas na borda. Reduza o TTL se isso for importante. A função calcula o hash da URL final com sha1, procura um arquivo com esse nome e o retorna quando a data de modificação é mais recente que o TTL. Caso contrário, ela busca, grava o corpo com LOCK_EX e retorna os dados.

Passo 7: o programa completo

Salve a função como amodb.php.

PHP 
<?php
declare(strict_types=1);

const AMODB_BASE = 'https://api.amodb.dev/3';

final class AmodbException extends RuntimeException
{
}

function amodb_get(string $path, array $query = [], int $ttl = 21600): array
{
    $key = getenv('AMODB_KEY');
    if ($key === false || $key === '') {
        throw new AmodbException('Set the AMODB_KEY environment variable.');
    }

    $url = AMODB_BASE . $path . ($query ? '?' . http_build_query($query) : '');
    $dir = sys_get_temp_dir() . '/amodb-cache';
    $file = $dir . '/' . sha1($url) . '.json';
    if (is_file($file) && time() - filemtime($file) < $ttl) {
        return json_decode((string) file_get_contents($file), true, 512, JSON_THROW_ON_ERROR);
    }

    for ($attempt = 1; $attempt <= 3; $attempt++) {
        $retryAfter = 1;
        $ch = curl_init($url);
        curl_setopt_array($ch, [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_CONNECTTIMEOUT => 5,
            CURLOPT_TIMEOUT => 10,
            CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . $key, 'Accept: application/json'],
            CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$retryAfter): int {
                if (stripos($line, 'retry-after:') === 0) {
                    $retryAfter = (int) trim(substr($line, 12));
                }
                return strlen($line);
            },
        ]);
        $body = curl_exec($ch);
        $status = (int) curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
        $error = curl_error($ch);

        if ($body === false) {
            throw new AmodbException('Network error: ' . $error);
        }
        if ($status !== 429 || $attempt === 3) {
            break;
        }
        sleep(max(1, min($retryAfter, 30)));
    }

    if ($status === 401) {
        throw new AmodbException('401: the API key is invalid or suspended.');
    }
    if ($status !== 200) {
        $detail = json_decode((string) $body, true)['status_message'] ?? 'no message';
        throw new AmodbException("amodb returned $status: $detail");
    }

    if (!is_dir($dir)) {
        mkdir($dir, 0775, true);
    }
    file_put_contents($file, $body, LOCK_EX);

    return json_decode($body, true, 512, JSON_THROW_ON_ERROR);
}

Depois salve a página como movie.php. Todo valor passa por htmlspecialchars antes de chegar ao HTML.

Inicie o servidor embutido com php -S localhost:8000 e abra http://localhost:8000/movie.php?id=603. A URL do pôster aponta para o host de imagens, que não precisa de chave.

PHP 
<?php
declare(strict_types=1);

require __DIR__ . '/amodb.php';

function h(?string $text): string
{
    return htmlspecialchars((string) $text, ENT_QUOTES, 'UTF-8');
}

$id = filter_input(INPUT_GET, 'id', FILTER_VALIDATE_INT) ?: 550;
$movie = null;
$error = null;
try {
    $movie = amodb_get("/movie/$id", ['language' => 'en-US', 'append_to_response' => 'credits,ratings']);
} catch (AmodbException $e) {
    http_response_code(502);
    $error = $e->getMessage();
}
$imdb = $movie['ratings']['imdb'] ?? null;
$cast = $movie ? array_slice(array_column($movie['credits']['cast'], 'name'), 0, 3) : [];
?>
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title><?= h($movie['title'] ?? 'Movie lookup') ?></title>
</head>
<body>
<?php if ($error !== null): ?>
  <p>Could not load the movie: <?= h($error) ?></p>
<?php else: ?>
  <h1><?= h($movie['title']) ?> (<?= h(substr((string) ($movie['release_date'] ?? ''), 0, 4)) ?>)</h1>
  <?php if (!empty($movie['poster_path'])): ?>
    <img src="https://img.amodb.dev/t/p/w342<?= h($movie['poster_path']) ?>" alt="Poster of <?= h($movie['title']) ?>" width="342">
  <?php endif; ?>
  <p><?= h($movie['overview'] ?? '') ?></p>
  <p>Cast: <?= h(implode(', ', $cast)) ?></p>
  <p>IMDb: <?= $imdb ? h((string) $imdb['value']) : 'not known' ?></p>
<?php endif; ?>
</body>
</html>

Próximos passos

  • Mova o cache da pasta temporária para um diretório que você controle e apague arquivos com mais de um dia com um job do cron.
  • Adicione language=ru-RU ou outro dos 14 idiomas e faça o cache de cada idioma separadamente, o que o hash da URL já faz.
  • Adicione moods a append_to_response e imprima a entrada de $movie['moods']['results'] com o maior avg. Veja moods (clima emocional).
  • Leia sobre limites de requisições ou compare com o tutorial de Go.