Pleaxy

Émettez des bons de commande, validez et payez les factures, et configurez votre espace de travail.

Recherche d’endpoints

Rechercher dans l’API acheteur

146 endpoints dans 19 ressources. Recherchez par chemin, méthode ou ce que vous voulez faire : collez une vraie URL et ses id correspondent aux paramètres du chemin.

Essayez

Référence de l’API

L’API Pleaxy est une API REST avec des requêtes et des réponses en JSON. Elle permet de lire et de créer des bons de commande et des factures, et de les suivre jusqu’à la validation et au paiement. Pour les concepts et les guides, consultez la documentation.

Authentification

Envoyez l’un de ces deux en-têtes avec chaque requête :

  • X-Api-Key: <keyId>.<secret> : une clé d’API, pour vos propres systèmes et agents.
  • Authorization: Bearer <accessToken> : la session d’une personne connectée, requise pour quelques actions comme la validation et la gestion des clés d’API.

Un identifiant fonctionne dans un seul espace de travail, en tant qu’acheteur ou fournisseur. Chaque chemin contient l’id de cet espace de travail sous la forme regionId ; copiez-le dans Pleaxy sous Profil de l’entreprise → ID de l’espace de travail.

Erreurs

Les erreurs utilisent des codes de statut 4xx et un corps JSON. Basez votre logique sur code, pas sur le message en anglais ; messageId et params vous permettent d’afficher le message dans votre langue.

Versions

Les chemins commencent par la version, /v1. De nouveaux endpoints, champs et valeurs y sont ajoutés : ignorez donc les champs que vous ne connaissez pas et prévoyez une valeur par défaut pour les valeurs inconnues, comme les statuts. Les changements incompatibles arrivent dans une nouvelle version.

URL de base
https://api.pleaxy.ai
Requête authentifiée
curl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Erreur
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Invoice INV-7F3A9C21 not found.",
  "code": "string",
  "messageId": "string",
  "params": { ... }
}

Ressources

Nous contacter