Aller au contenu

API

Résumé

L'API AndroMate permet de piloter vos automatisations de façon programmatique — depuis un pipeline CI/CD, un script ou une intégration tierce — sans passer par l'interface web.

Vous vous authentifiez avec une clé API et appelez des endpoints dédiés sous le chemin /job/api/. La clé identifie son propriétaire : chaque appel est donc automatiquement limité à vos propres jobs et devices.


URL de base

Tous les appels visent votre backend job :

https://<votre-backend-job>

Exemple (dev) : https://dev.job.andromate.net


Authentification

Chaque requête doit porter votre clé dans l'en‑tête X-API-Key :

X-API-Key: amk_live_xxxxxxxxxxxxxxxxxxxxxxxx
  • Pas de JWT, pas d'en‑tête X-Role — la clé seule authentifie la requête.
  • Le propriétaire est résolu depuis la base de données, jamais depuis le corps de la requête.

Voir Clés API pour créer et gérer vos clés.


Convention de chemin

Préfixe Auth Usage
/job/api/... Clé API (X-API-Key) accès programmatique (cette section)
autres chemins JWT (session web) les apps web/mobile

Endpoints disponibles

Endpoint Méthode Description
/job/api/jobs/execute POST Lancer un job sur un ou plusieurs devices
/job/api/jobs/executions/{id} GET Consulter l'état courant d'une exécution

Format d'erreur

Toute erreur renvoie la même structure JSON :

{
  "code": "J-803",
  "message": "API key is expired",
  "status": 403
}

Voir chaque page d'endpoint pour les codes d'erreur spécifiques.