Interfaces applicatives · AGITEX

API &
intégrations

Des contrats prévisibles, documentés, sécurisés et compatibles avec les clients existants.

Principe de conception

Chaque API constitue le contrat entre les interfaces, les services et les partenaires. Elle doit exprimer clairement une ressource, une action, une réponse et ses règles de sécurité.

Convention générale

Un contrat lisible et stable

01Méthodes

Verbes HTTP associés précisément à chaque action.

02Ressources

Noms stables et collections au pluriel.

03Identifiants

Clés documentées, numériques ou opaques.

04Réponses

Statut HTTP et représentation utile.

05Erreurs

Code, message et détails sans exposition sensible.

06Pagination

Collections limitées et navigation explicite.

07Filtrage

Critères validés et non ambigus.

08Versionnage

Compatibilité annoncée pendant une période définie.

Réponse réussie200 OK

{
  "success": true,
  "data": {},
  "meta": { "traceId": "exemple-trace-id" }
}

Erreur de validation422 Unprocessable

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Une ou plusieurs données sont invalides."
  }
}

Sécurité des échanges

Chaque appel est protégé

AuthentificationAutorisationHTTPSLimites de requêtesPas de secret URLIdentifiant de trace

Exemple d’intégrationCollection de produits

GET /api/v1/produits HTTP/1.1
Authorization: Bearer {token}
Accept: application/json