Paramètres globaux

Ces paramètres peuvent être utilisés avec n'importe quel endpoint de l'API.

Paramètre	Type	Défaut	Description
`x_api_key`	`string`	-	Clé d'authentification requise pour toutes les requêtes. À transmettre via l'en-tête `x-api-key` ou en paramètre de requête.
`soft_fail`	`boolean`	`false`	Lorsque `true`, l'API retourne HTTP 200 même en cas d'erreur. Les erreurs restent suivies et facturées normalement.
`is_async`	`boolean`	`false`	Lorsque `true`, la requête est traitée de façon asynchrone. La réponse contient un `job_id` à interroger sur `/jobs/{job_id}`.
`fields`	`string`	-	Liste de champs séparés par des virgules à inclure dans la réponse. Supporte les champs imbriqués avec la notation par point.

Filtrage des champs

Utilisez le paramètre fields pour ne récupérer que les données dont vous avez réellement besoin. La réponse est plus petite, plus rapide à télécharger et plus simple à parser côté client. C'est particulièrement utile quand votre plateforme impose une limite de taille de payload (Make.com, Zapier, Lambdas avec peu de mémoire, etc.).

Syntaxe

Passez fields sous forme de liste séparée par des virgules. Utilisez un point (.) pour descendre dans un objet imbriqué.

Champs de premier niveau listés par leur nom : fields=name,founded.
Champs imbriqués avec la notation par point : fields=address.city,address.country.
Les espaces autour des virgules sont ignorés : fields=name, founded fonctionne pareil.
Les noms de champ inconnus sont ignorés silencieusement, aucune erreur n'est renvoyée.

Sélectionner des champs de premier niveau

Conservez uniquement les clés de premier niveau qui vous intéressent. La structure d'origine est préservée pour les champs gardés.

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

Réponse:

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

Sélectionner des champs imbriqués

Utilisez la notation par point pour atteindre les objets imbriqués. Seuls les sous-champs demandés sont renvoyés, le reste de l'objet parent est supprimé. La notation par point fonctionne aussi sur les objets dans un tableau : ?fields=team.name garde le name de chaque élément 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"

Réponse:

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

À savoir

Le filtrage est appliqué après la récupération des données : il ne réduit pas le coût en crédits de l'appel. Il réduit la taille de la réponse, le temps de parsing et la bande passante.
Les clés de premier niveau non listées dans fields sont retirées de la réponse. Lister un champ imbriqué garde automatiquement son objet parent.
Vous pouvez combiner fields librement avec d'autres paramètres comme soft_fail ou is_async.

Mode soft fail

Gérez les erreurs en douceur en recevant toujours un code 200.

Ajoutez soft_fail=true à n'importe quelle requête pour recevoir HTTP 200 même en cas d'erreur.

Les erreurs restent suivies dans votre tableau de bord et facturées selon les règles standard.

Cas d'usage

Systèmes qui considèrent les codes non-200 comme fatals (Make.com, Zapier)
Gestion d'erreur personnalisée dans votre application
Gestion d'erreur cohérente entre plusieurs intégrations

Note pour les utilisateurs Make.com : par défaut, les scénarios Make.com s'arrêtent en erreur lorsqu'ils reçoivent un code HTTP 404 ou 500. Utiliser soft_fail=true permet à votre scénario de continuer même si l'API retourne une erreur, pour la gérer dans les modules suivants.

Exemple

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

{
  "error": "Not Found"
}

Mode asynchrone

Pour les requêtes longues, utilisez le mode asynchrone pour éviter les timeouts.

Ajoutez is_async=true pour recevoir immédiatement un job_id.

Fonctionnement

Envoyez la requête avec is_async=true
Recevez un job_id
Interrogez /jobs/{job_id} pour récupérer le résultat

# Étape 1 : démarrer le job
curl -X GET "https://api.autom.dev/{endpoint}?param=value&is_async=true" \
  -H "x-api-key: YOUR_API_KEY"
# Réponse: { "job_id": "abc123..." }

# Étape 2 : récupérer le résultat
curl -X GET "https://api.autom.dev/jobs/abc123..." \
  -H "x-api-key: YOUR_API_KEY"

Consultez les codes de statut pour les codes de réponse, les bonnes pratiques pour l'intégration et la gestion des erreurs pour les stratégies de retry.

Sur cette page