API Publique

Apercu

L'API Publique AutoGMS offre aux partenaires d'integration un acces programmatique aux donnees de votre garage. Utilisez-la pour connecter des outils de diagnostic, des plateformes de gestion de flotte, des tableaux de bord personnalises, des catalogues de pieces et des applications mobiles a votre compte AutoGMS.

Caracteristiques principales :

• Acces complet en lecture et ecriture a toutes les donnees du garage, y compris les reservations, clients, vehicules, inventaire, factures et plus
• Webhooks -- recevoir des notifications en temps reel lorsque des evenements se produisent dans votre garage
• Authentification par cle API avec limitation de debit par cle et niveaux de permission
• Portee par garage -- chaque requete est liee a un garage specifique
• Journalisation d'audit -- toute activite API est enregistree et visible dans le panneau d'administration
• Support multi-garage -- une seule cle peut acceder a plusieurs garages de votre organisation

---

Comment Acceder

Les cles API sont creees et gerees par votre administrateur AutoGMS (super admin). Si vous avez besoin d'un acces API, contactez votre administrateur pour demander une cle.

Une fois votre cle API recue, vous pouvez commencer a effectuer des requetes immediatement.

---

Demarrage

Etape 1 : Demander une Cle API

Contactez votre administrateur AutoGMS pour demander une cle API. Lors de votre demande, indiquez-leur :

• L'objectif d'utilisation -- ex. "Tableau de bord Flotte", "Integration Catalogue Pieces", "Outil de Diagnostic".
• Le niveau de permission -- Lecture Seule pour les tableaux de bord et rapports, ou Lecture et Ecriture pour les integrations completes.
• Les garages concernes -- Precisez si vous n'avez besoin d'acceder qu'a certains garages.

Votre administrateur vous fournira une cle API. Conservez-la en securite -- elle ne peut pas etre recuperee apres sa creation.

Etape 2 : Effectuer Votre Premiere Requete

Utilisez votre cle API dans l'en-tete X-API-Key :

GET https://api.autogms.com/api/v1/garages
X-API-Key: agms_pk_live_your_key_here

Ceci retourne une liste de tous les garages accessibles par votre cle.

Etape 3 : Acceder aux Donnees du Garage

Tous les endpoints de donnees necessitent un identifiant de garage dans l'URL :

GET https://api.autogms.com/api/v1/garages/{garageId}/bookings
X-API-Key: agms_pk_live_your_key_here

---

Donnees Disponibles

L'API fournit un acces en lecture et ecriture a tous les domaines principaux de votre garage :

Ressource	Lecture	Ecriture
Garages	Details de localisation, coordonnees	--
Clients	Profils, historique des reservations, vehicules	Creer, modifier clients et vehicules
Vehicules	Details du vehicule, decodage VIN	Creer, modifier, supprimer vehicules
Reservations	Toutes les reservations avec statut, techniciens, pieces, etapes	Creer, modifier, changer statut, supprimer, assigner techniciens et pieces
Etapes de Reservation	Etapes de travail avec techniciens assignes	Creer, modifier, changer statut, supprimer etapes
Techniciens	Liste de l'equipe, statistiques de performance, travail assigne	--
Services	Catalogue de services avec tarification	--
Inventaire	Niveaux de stock, alertes de stock bas, recherche par code-barres	Creer articles, modifier details, ajuster stock
Factures	Details des factures, statut de paiement	--
Devis	Details des devis, statut d'approbation, lignes de detail	Creer, modifier, envoyer devis
Bons de Commande	Details des bons, statistiques d'approvisionnement	--
Baies	Disponibilite des baies et affectations en cours	--
Webhooks	Liste des abonnements, historique de livraison	Creer, modifier, supprimer, tester webhooks

Note : Les operations d'ecriture necessitent une cle API Lecture et Ecriture. Les cles en lecture seule ne peuvent acceder qu'aux endpoints GET.

---

Cas d'Utilisation Courants

Integration Diagnostic

Connectez vos equipements de diagnostic pour rechercher des vehicules et creer des reservations :

GET  /api/v1/garages/{garageId}/vehicles/vin-lookup?vin=JTMHY7AJ5E4012345
POST /api/v1/garages/{garageId}/bookings

Tableau de Bord Gestion de Flotte

Surveillez tous les travaux actifs, les charges de travail des techniciens et la disponibilite des baies :

GET /api/v1/garages/{garageId}/bookings/counts
GET /api/v1/garages/{garageId}/technicians
GET /api/v1/garages/{garageId}/bays

Integration Catalogue de Pieces

Verifiez les niveaux d'inventaire, ajustez le stock et obtenez des alertes de stock bas :

GET  /api/v1/garages/{garageId}/inventory?lowStock=true
GET  /api/v1/garages/{garageId}/inventory/barcode/6291041500123
POST /api/v1/garages/{garageId}/inventory/{itemId}/adjust

Automatisation des Reservations

Creez des reservations, assignez des techniciens et gerez les etapes de travail de maniere programmatique :

POST /api/v1/garages/{garageId}/bookings
POST /api/v1/garages/{garageId}/bookings/{bookingId}/status
POST /api/v1/garages/{garageId}/bookings/{bookingId}/technician
POST /api/v1/garages/{garageId}/bookings/{bookingId}/stages

Notifications en Temps Reel (Webhooks)

Recevez des notifications instantanees lorsque des evenements se produisent dans votre garage :

POST /api/v1/garages/{garageId}/webhooks

Abonnez-vous a des evenements comme booking.completed, inventory.low_stock, invoice.paid, et plus. AutoGMS envoie un HTTP POST a votre URL chaque fois que l'evenement se produit.

Evenements webhook v1 courants :

• customer.created
• booking.created
• booking.updated
• booking.status_changed
• booking.completed
• technician.assigned
• estimate.created
• estimate.sent
• inventory.low_stock

API WhatsApp

AutoGMS ne fournit pas d'API WhatsApp separee pour envoyer vos propres messages WhatsApp directement. Pour les workflows garage pris en charge, AutoGMS prepare les messages WhatsApp dans le tableau de bord, par exemple pour les factures, devis, bons de commande, rappels MOT, inspections et rappels de service. Dans la plupart des cas, vous verifiez le message prepare puis vous l'envoyez via WhatsApp.

Utilisez l'API Publique pour les donnees du garage, les reservations, clients, vehicules, inventaire, factures, devis, bons de commande et webhooks. Si vous avez besoin d'une integration WhatsApp personnalisee ou d'une automatisation WhatsApp directe, contactez le support avec le workflow, le volume de messages attendu et indiquez si les messages sont transactionnels ou marketing.

Rapports Personnalises

Recuperez des donnees financieres pour des outils de reporting externes :

GET /api/v1/garages/{garageId}/invoices?status=paid&dateFrom=2026-01-01
GET /api/v1/garages/{garageId}/purchase-orders/stats

---

Format de Reponse API

Toutes les reponses utilisent un format JSON coherent.

Reponse reussie :

{
  "success": true,
  "data": { ... }
}

Reponse liste avec pagination :

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156,
    "totalPages": 8,
    "hasMore": true
  }
}

Reponse d'erreur :

{
  "success": false,
  "error": {
    "type": "NotFoundError",
    "message": "Booking not found",
    "code": "RESOURCE_NOT_FOUND"
  }
}

Erreurs courantes de planification pour les integrations en ecriture :

• GARAGE_CLOSED (409)
• DATE_AT_CAPACITY (409)
• TIMESLOT_REQUIRED (400) lorsqu'un creneau est obligatoire et qu'aucun timeslot n'est envoye
• INVALID_TIMESLOT (400) lorsque timeslot n'est pas valide pour cette date
• SLOT_AT_CAPACITY (409)
• ACTIVE_JOB_EXISTS (409)

Si le garage utilise la planification par creneaux, incluez un champ timeslot au format HH:MM dans les ecritures de reservation :

{
  "date": "2026-03-04",
  "timeslot": "09:00"
}

---

Pagination et Filtrage

Pagination

Tous les endpoints de liste supportent la pagination :

Parametre	Defaut	Max	Description
page	1	--	Numero de page
limit	20	100	Elements par page

Exemple : GET /api/v1/garages/{garageId}/bookings?page=2&limit=50

Tri

Utilisez le parametre sort. Prefixez avec - pour l'ordre decroissant :

• sort=-date -- Plus recent en premier
• sort=name -- Alphabetique

Filtrage par Date

La plupart des endpoints de liste supportent le filtrage par plage de dates :

• dateFrom=2026-01-01 -- Enregistrements a partir de cette date
• dateTo=2026-01-31 -- Enregistrements jusqu'a cette date

---

Limitation de Debit

Chaque cle API a une limite de requetes par minute selon son niveau :

Niveau	Requetes par Minute
Standard	60
Premium	300
Entreprise	1 000

Chaque reponse inclut des en-tetes de limitation de debit :

RateLimit-Limit: 60
RateLimit-Remaining: 42
RateLimit-Reset: 1706000000

Si vous depassez la limite, vous recevrez une reponse 429 Too Many Requests. Attendez que la periode Retry-After expire avant de faire d'autres requetes.

---

Gestion des Cles API

Les cles API sont gerees par votre administrateur AutoGMS. Si vous avez besoin de l'une des actions suivantes, contactez votre administrateur :

• Consulter les statistiques d'utilisation -- Votre administrateur peut voir le nombre de requetes, les taux d'erreur et l'activite recente pour chaque cle.
• Rotation d'une cle -- Si une cle a pu etre compromise, demandez a votre administrateur de la faire tourner. Cela genere une nouvelle cle et invalide l'ancienne.
• Revoquer une cle -- Pour desactiver definitivement une cle, demandez a votre administrateur de la revoquer.

La rotation et la revocation des cles sont des actions permanentes gerees par votre administrateur.

---

Reference Complete des Endpoints

Tous les endpoints sont prefixes avec /api/v1. Les endpoints de ressources utilisent /garages/{garageId}/.

Garages

Endpoint	Description
GET /garages	Lister tous les garages accessibles par cette cle
GET /garages/{garageId}	Details du garage

Clients

Endpoint	Description
GET /garages/{gid}/customers	Lister les clients du garage
GET /garages/{gid}/customers/search?q=ahmed	Rechercher par nom, email ou telephone
POST /garages/{gid}/customers	Creer un client
PATCH /garages/{gid}/customers/{cid}	Modifier un client
GET /garages/{gid}/customers/{cid}	Client avec statistiques de reservations
GET /garages/{gid}/customers/{cid}/vehicles	Lister les vehicules du client
POST /garages/{gid}/customers/{cid}/vehicles	Ajouter un vehicule au client
GET /garages/{gid}/customers/{cid}/bookings	Lister les reservations du client

Ordre des vehicules : Les resultats de vehicules limites a un client sont aussi limites au garage de la requete. Le vehicule par defaut apparait en premier. Les autres sont classes par date de mise a jour la plus recente, puis par date de creation la plus recente. GET /garages/{gid}/vehicles sans customerId reste classe par date de creation la plus recente.

Vehicules

Endpoint	Description
GET /garages/{gid}/vehicles	Lister tous les vehicules
POST /garages/{gid}/vehicles	Creer un vehicule
PATCH /garages/{gid}/vehicles/{vid}	Modifier un vehicule
DELETE /garages/{gid}/vehicles/{vid}	Supprimer un vehicule
GET /garages/{gid}/vehicles/{vid}	Details du vehicule
GET /garages/{gid}/vehicles/vin-lookup?vin=...	Decoder un VIN

Reservations

Endpoint	Description
GET /garages/{gid}/bookings	Lister les reservations (filtrer par statut, date, client, technicien)
POST /garages/{gid}/bookings	Creer une reservation
GET /garages/{gid}/bookings/counts	Compteurs par statut
GET /garages/{gid}/bookings/{bid}	Detail complet de la reservation
PATCH /garages/{gid}/bookings/{bid}	Modifier une reservation
DELETE /garages/{gid}/bookings/{bid}	Supprimer definitivement une reservation en attente intacte, sans historique de travail, communication, integration ou finance
POST /garages/{gid}/bookings/{bid}/status	Changer le statut de la reservation
POST /garages/{gid}/bookings/{bid}/technician	Assigner un technicien
GET /garages/{gid}/bookings/{bid}/inventory	Lister les pieces assignees
POST /garages/{gid}/bookings/{bid}/inventory	Assigner des pieces a la reservation
GET /garages/{gid}/bookings/{bid}/parts	Lister les pieces assignees (alias)
GET /garages/{gid}/bookings/{bid}/attachments	Lister les pieces jointes
GET /garages/{gid}/bookings/{bid}/stages	Lister les etapes du projet
POST /garages/{gid}/bookings/{bid}/stages	Creer une etape
PATCH /garages/{gid}/bookings/{bid}/stages/{sid}	Modifier une etape
POST /garages/{gid}/bookings/{bid}/stages/{sid}/status	Changer le statut de l'etape
DELETE /garages/{gid}/bookings/{bid}/stages/{sid}	Supprimer une etape

Techniciens

Endpoint	Description
GET /garages/{gid}/technicians	Lister les techniciens
GET /garages/{gid}/technicians/{tid}/stats	Statistiques de performance
GET /garages/{gid}/technicians/{tid}/bookings	Reservations assignees

Services

Endpoint	Description
GET /garages/{gid}/services	Catalogue de services
GET /garages/{gid}/services/{sid}	Details du service
GET /garages/{gid}/services/{sid}/prices	Tarification par type de vehicule

Inventaire

Endpoint	Description
GET /garages/{gid}/inventory	Lister les articles
POST /garages/{gid}/inventory	Creer un article d'inventaire
GET /garages/{gid}/inventory/{iid}	Details de l'article
PATCH /garages/{gid}/inventory/{iid}	Modifier un article
POST /garages/{gid}/inventory/{iid}/adjust	Ajuster le stock (ajouter ou soustraire)
GET /garages/{gid}/inventory/low-stock	Articles sous le seuil
GET /garages/{gid}/inventory/categories	Categories avec compteurs
GET /garages/{gid}/inventory/stats	Statistiques d'inventaire
GET /garages/{gid}/inventory/barcode/{code}	Recherche par code-barres

Factures

Endpoint	Description
GET /garages/{gid}/invoices	Lister les factures
GET /garages/{gid}/invoices/{iid}	Detail de la facture

Devis

Endpoint	Description
GET /garages/{gid}/estimates	Lister les devis
POST /garages/{gid}/estimates	Creer un devis
GET /garages/{gid}/estimates/{eid}	Detail du devis
PATCH /garages/{gid}/estimates/{eid}	Modifier un devis
POST /garages/{gid}/estimates/{eid}/send	Envoyer un devis au client

Mises à jour des devis, conflits et expectedVersion

Les clients de l'API publique qui modifient des devis doivent d'abord lire le devis, puis envoyer sa dernière valeur entière expectedVersion avec chaque appel PATCH. Il s'agit du jeton de modification, distinct du numéro de révision visible version. Les clients v1 existants peuvent l'omettre pendant la période de transition, mais ces requêtes ne peuvent pas détecter les modifications effectuées avant leur lancement. Une réponse 409 ESTIMATE_EDIT_CONFLICT signifie que le devis a changé ; récupérez-le à nouveau et comparez les modifications avant de réessayer. Un jeton actuel ne contourne pas les verrouillages du workflow : les devis envoyés, approuvés et remplacés renvoient 409 STATUS_TRANSITION_BLOCKED.

Bons de Commande

Endpoint	Description
GET /garages/{gid}/purchase-orders	Lister les bons de commande
GET /garages/{gid}/purchase-orders/{pid}	Detail du bon de commande
GET /garages/{gid}/purchase-orders/stats	Statistiques d'approvisionnement

Baies

Endpoint	Description
GET /garages/{gid}/bays	Lister les baies avec statut actuel

Webhooks

Endpoint	Description
GET /garages/{gid}/webhooks	Lister vos abonnements webhook
POST /garages/{gid}/webhooks	Creer un abonnement webhook
PATCH /garages/{gid}/webhooks/{wid}	Modifier un webhook
DELETE /garages/{gid}/webhooks/{wid}	Supprimer un webhook
POST /garages/{gid}/webhooks/{wid}/test	Envoyer un evenement de test
GET /garages/{gid}/webhooks/{wid}/deliveries	Consulter l'historique de livraison

---

Bientot Disponible

• OAuth 2.0 -- Authentification tierce pour les integrations marketplace

---

Besoin d'Aide ?

• Demander une cle API : Contactez votre administrateur AutoGMS
• Problemes de cles (rotation, revocation) : Contactez votre administrateur AutoGMS
• Support general : Envoyez un email a support@myautogms.com