Parámetros globales

Estos parámetros pueden usarse con cualquier endpoint de la API.

Parámetro	Tipo	Por defecto	Descripción
`x_api_key`	`string`	-	Clave de autenticación requerida para todas las solicitudes. Pásela en el encabezado `x-api-key` o como parámetro de consulta.
`soft_fail`	`boolean`	`false`	Cuando es `true`, la API devuelve HTTP 200 incluso si ocurre un error. Los errores se siguen registrando y facturando con normalidad.
`is_async`	`boolean`	`false`	Cuando es `true`, la solicitud se procesa de forma asíncrona. La respuesta contiene un `job_id` que se consulta en `/jobs/{job_id}`.
`fields`	`string`	-	Lista de campos separados por comas para incluir en la respuesta. Admite campos anidados con notación de punto.

Filtrado de campos

Use el parámetro fields para conservar solo los datos que realmente necesita en la respuesta. Esto hace que las respuestas sean más pequeñas, más rápidas de descargar y más fáciles de procesar en su lado. Es especialmente útil cuando su plataforma impone un límite de tamaño de payload (Make.com, Zapier, Lambdas con poca memoria, etc.).

Sintaxis

Pase fields como una lista separada por comas. Use un punto (.) para descender a un objeto anidado.

Los campos de primer nivel se listan por su nombre: fields=name,founded.
Los campos anidados usan notación de punto: fields=address.city,address.country.
Los espacios alrededor de las comas se ignoran: fields=name, founded funciona igual.
Los nombres de campo desconocidos se ignoran silenciosamente, no se devuelve ningún error.

Seleccionar campos de primer nivel

Conserve solo las claves de primer nivel que le interesan. La estructura original se preserva para los campos conservados.

curl -X GET "https://api.autom.dev/{endpoint}?param=value&fields=name,founded,tagline" \
  -H "x-api-key: YOUR_API_KEY"

Respuesta:

{
  "name": "Example",
  "founded": "2020",
  "tagline": "Just an example"
}

Seleccionar campos anidados

Use la notación de punto para llegar a objetos anidados. Solo se devuelven los subcampos solicitados, el resto del objeto padre se descarta. La notación de punto también funciona para objetos dentro de arrays: ?fields=team.name conserva el name de cada elemento de team.

curl -X GET "https://api.autom.dev/{endpoint}?param=value&fields=name,location.city,location.country" \
  -H "x-api-key: YOUR_API_KEY"

Respuesta:

{
  "name": "Example",
  "location": {
    "city": "Paris",
    "country": "France"
  }
}

A tener en cuenta

El filtrado ocurre después de obtener los datos: no reduce el coste en créditos de la llamada. Sí reduce el tamaño de la respuesta, el tiempo de parsing y el ancho de banda.
Las claves de primer nivel no listadas en fields se eliminan de la respuesta. Listar campos anidados conserva automáticamente su objeto padre.
Puede combinar fields libremente con otros parámetros como soft_fail o is_async.

Modo soft fail

Gestione los errores con elegancia recibiendo siempre un código 200.

Añada soft_fail=true a cualquier solicitud para recibir HTTP 200 incluso cuando ocurre un error.

Los errores se siguen registrando en su panel y se facturan según las reglas estándar.

Casos de uso

Sistemas que tratan los códigos no-200 como fatales (Make.com, Zapier)
Manejo de errores personalizado en su aplicación
Manejo de errores coherente entre integraciones

Nota para usuarios de Make.com: por defecto, los escenarios de Make.com se detienen con error cuando reciben un código HTTP 404 o 500. Usar soft_fail=true permite que su escenario continúe ejecutándose incluso cuando la API devuelve un error, para que pueda gestionarlo en módulos posteriores.

Ejemplo

curl -X GET "https://api.autom.dev/{endpoint}?param=invalid&soft_fail=true" \
  -H "x-api-key: YOUR_API_KEY"

{
  "error": "Not Found"
}

Modo asíncrono

Para solicitudes que tardan mucho, use el modo asíncrono para evitar timeouts.

Añada is_async=true para recibir un job_id de inmediato.

Cómo funciona

Envíe la solicitud con is_async=true
Reciba un job_id
Consulte /jobs/{job_id} para obtener el resultado

# Paso 1: iniciar el job
curl -X GET "https://api.autom.dev/{endpoint}?param=value&is_async=true" \
  -H "x-api-key: YOUR_API_KEY"
# Respuesta: { "job_id": "abc123..." }

# Paso 2: obtener el resultado
curl -X GET "https://api.autom.dev/jobs/abc123..." \
  -H "x-api-key: YOUR_API_KEY"

Consulte los códigos de estado para los códigos de respuesta, las buenas prácticas para integración y el manejo de errores para estrategias de reintento.

Parámetros globales

En esta página