PHP

El SDK oficial de PHP de Autom, con un método tipado por endpoint y un request() genérico para lo demás.

RequisitosCopiar enlace del ancla

• PHP 8.1+

InstalaciónCopiar enlace del ancla

composer require autom/sdk

Obtén tu clave de APICopiar enlace del ancla

Copia tu clave de API desde el panel de Autom y guárdala en la variable de entorno AUTOM_API_KEY, que el SDK lee por defecto. No la incluyas en el control de versiones.

Inicio rápidoCopiar enlace del ancla

<?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);

Trabajos asíncronosCopiar enlace del ancla

Cualquier llamada acepta is_async, útil más allá del límite de 60 segundos del servidor. La respuesta es entonces un job_id, y el SDK puede esperar a que termine el trabajo.

$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);

ErroresCopiar enlace del ancla

Una respuesta fuera de 2xx lanza un error de API con su estado y su mensaje. Consulta los códigos de estado para ver la lista completa.

use Autom\Exception\ApiException;

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

ReintentosCopiar enlace del ancla

Las solicitudes se reintentan hasta 3 veces tras un error de red, un 408, 500, 502, 503 o 504, o un límite de frecuencia del plan. Los errores de cuota por clave y los tiempos de espera del cliente no se reintentan. La espera empieza en 1 segundo y crece 1,5× en cada reintento, y una cabecera Retry-After tiene prioridad.

$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

Solicitudes por lotesCopiar enlace del ancla

Ejecuta muchas llamadas a la vez, 10 por defecto. Un fallo no detiene las demás.

$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";
    }
}

Cualquier endpointCopiar enlace del ancla

request() llega a cualquier ruta, incluidos los endpoints publicados después de tu versión del SDK.

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

Errores frecuentesCopiar enlace del ancla

• Poner la clave de API en el código front-end. Cualquiera podría leerla. Llama a la API desde tu servidor.
• Tratar todo 401 como una clave incorrecta. Un 401 también puede ser un límite de frecuencia: lee el mensaje. El SDK reintenta por ti los límites del plan.
• Reintentar un 402. Significa que no quedan créditos ni cuota, así que un reintento no puede funcionar. Consulta Créditos.
• Esperar solicitudes largas. Más allá de 60 segundos, usa el modo asíncrono como se muestra arriba en lugar de aumentar el tiempo de espera. Consulta Timeout.

EnlacesCopiar enlace del ancla

• Paquete: autom/sdk
• Código fuente: github.com/automdev/autom-php
• Referencia de la API