Documentation technique
Référence de l’API, du système d’événements, des webhooks et des protocoles pour les agents de XEN, destinée à l’équipe technique qui intègre la plateforme à ses propres systèmes.
La référence est publiée section par section, dans l’ordre de ce sommaire.
Chaque section sort avec ses exemples de requête et de réponse vérifiés sur le serveur de production. Une équipe qui doit intégrer dès aujourd’hui reçoit la référence des points de terminaison qu’elle utilise et une personne de Xeneural pendant l’intégration.
Demander la référence pour une intégrationHuit sections
Authentification
Chaque requête porte le jeton de session de l’utilisateur dans l’en-tête d’autorisation ; le serveur le valide, identifie l’utilisateur et rejette toute requête sans jeton avant de toucher la moindre donnée.
Périmètre de l’organisation
L’organisation active est déterminée par le serveur à partir de la session ; le client ne la déclare jamais dans la requête, si bien qu’un identifiant envoyé de l’extérieur ne peut pas ouvrir les données d’une autre entreprise.
Points de terminaison de ventes
Émission de documents, brouillons et programmation ; consultation du statut ; avoirs et notes de débit rattachés au document d’origine ; séries par point d’émission.
Points de terminaison d’inventaire
Mouvements d’entrée et de sortie, transferts entre entrepôts, ajustements avec motif et consultation du stock physique et disponible par article et par entrepôt.
Système d’événements
Tout résultat du serveur porte un code d’événement court et séquentiel issu d’un registre unique ; les codes se lisent dans le même catalogue depuis l’application, les intégrations et les agents.
Webhooks
Enregistrement d’une destination par organisation, format de l’envoi, signature pour vérifier l’origine et politique de nouvelles tentatives quand la destination ne répond pas.
Protocoles pour les agents
Comment un agent externe s’autorise avec MCP, AP2 et UCP, travaille avec les autorisations de l’utilisateur qui l’a autorisé et laisse chaque action dans le même historique qu’une personne.
Erreurs et codes
Forme de la réponse d’erreur, catalogue des codes par famille (validation, autorisations, fiscal, intégration) et ce qu’il faut corriger dans chaque cas avant de réessayer.