Node.js

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

RequisitosCopiar enlace del ancla

• Node.js 20+

InstalaciónCopiar enlace del ancla

npm install @automdev/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

import { AutomClient } from "@automdev/sdk";

const client = new AutomClient({ apiKey: process.env.AUTOM_API_KEY });

const response = await client.googleSearch({ query: "web scraping api" });
console.log(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.

const submitted = await client.googleSearch({
  query: "web scraping api",
  is_async: true,
});
const job = await client.waitForJob(submitted.data.job_id, {
  onProgress: (j) => console.log(`${j.status} ${j.progress ?? 0}%`),
});
console.log(JSON.stringify(job.data, null, 2));

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.

import { AutomApiError } from "@automdev/sdk";

try {
  await client.googleSearch({ query: "web scraping api" });
} catch (error) {
  if (error instanceof AutomApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}

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.

const client = new AutomClient({ maxRetries: 5, retryDelay: 500 });

// or for one request
await client.googleSearch({ query: "web scraping api" }, { maxRetries: 0 });

Solicitudes por lotesCopiar enlace del ancla

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

const inputs = ["web scraping api", "serp api", "rank tracker"];
const results = await client.batch(
  inputs,
  (query) => client.googleSearch({ query }),
  { concurrency: 5 },
);

for (const result of results) {
  if (result.status === "fulfilled") console.log(result.value.data);
  else console.error(inputs[result.index], result.reason);
}

Cualquier endpointCopiar enlace del ancla

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

const response = await 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: @automdev/sdk
• Código fuente: github.com/automdev/autom-node
• Referencia de la API