PHP

O SDK PHP oficial da Autom, com um método tipado por endpoint e um request() genérico para o resto.

RequisitosCopiar link da âncora

• PHP 8.1+

InstalaçãoCopiar link da âncora

composer require autom/sdk

Obtenha sua chave de APICopiar link da âncora

Copie sua chave de API no painel da Autom e coloque-a na variável de ambiente AUTOM_API_KEY, que o SDK lê por padrão. Não a inclua no controle de versão.

Início rápidoCopiar link da âncora

<?php

require 'vendor/autoload.php';

use Autom\Client;

$client = new Client(getenv('AUTOM_API_KEY') ?: null);
$response = $client->googleSearch(['query' => 'web scraping api']);
print_r($response->data);

Jobs assíncronosCopiar link da âncora

Qualquer chamada aceita is_async, útil além do limite de 60 segundos do servidor. A resposta é então um job_id, e o SDK pode aguardar o fim do job.

$submitted = $client->googleSearch(['query' => 'web scraping api', 'is_async' => true]);
$job = $client->waitForJob($submitted->data['job_id'], onProgress: static function (array $job): void {
    echo $job['status'], ' ', $job['progress'] ?? 0, "%\n";
});
print_r($job->data);

ErrosCopiar link da âncora

Uma resposta fora de 2xx gera um erro de API com status e mensagem. Veja os códigos de status para a lista completa.

use Autom\Exception\ApiException;

try {
    $client->googleSearch(['query' => 'web scraping api']);
} catch (ApiException $exception) {
    echo $exception->status, ': ', $exception->getMessage();
}

Novas tentativasCopiar link da âncora

As requisições são repetidas até 3 vezes após um erro de rede, um 408, 500, 502, 503 ou 504, ou um limite de taxa do plano. Erros de cota por chave e timeouts do cliente não são repetidos. A espera começa em 1 segundo e cresce 1,5× a cada tentativa, e um cabeçalho Retry-After tem prioridade.

$client = new Client(null, ['max_retries' => 5, 'retry_delay' => 0.5]);
$client->googleSearch(['query' => 'web scraping api'], new RequestOptions(maxRetries: 0)); // one request without retries

Requisições em loteCopiar link da âncora

Execute muitas chamadas de uma vez, 10 por padrão. Uma falha não interrompe as outras.

$inputs = ['web scraping api', 'serp api', 'rank tracker'];
$calls = array_map(static fn(string $value): array => ['googleSearch', ['query' => $value]], $inputs);

foreach ($client->batch($calls, concurrency: 5) as $result) {
    if ($result->ok()) {
        print_r($result->value->data);
    } else {
        echo $inputs[$result->index], ': ', $result->error->getMessage(), "\n";
    }
}

Qualquer endpointCopiar link da âncora

request() alcança qualquer caminho, inclusive endpoints lançados depois da sua versão do SDK.

$response = $client->request('GET', '/v1/usage');

Erros comunsCopiar link da âncora

• Colocar a chave de API no código front-end. Qualquer pessoa poderia lê-la. Chame a API a partir do seu servidor.
• Tratar todo 401 como chave incorreta. Um 401 também pode ser um limite de taxa: leia a mensagem. O SDK repete automaticamente os limites do plano.
• Repetir um 402. Não há mais créditos nem cota, então uma nova tentativa não pode funcionar. Veja Créditos.
• Esperar requisições longas. Acima de 60 segundos, use o modo assíncrono como mostrado acima em vez de aumentar o timeout. Veja Timeout.

LinksCopiar link da âncora

• Pacote: autom/sdk
• Código-fonte: github.com/automdev/autom-php
• Referência da API