Skip to main content
L’API Acheteur d’OpenWrench donne aux exploitants d’installations un accès programmatique à l’ensemble du côté acheteur de la plateforme : création et suivi des bons de travail, gestion des actifs et des emplacements, révision des soumissions et des factures, surveillance de l’entretien préventif et interrogation de votre réseau de fournisseurs.

​
URL de base

Tous les endpoints acheteur sont sous /v1/buyer/.

​
Authentification

Chaque requête doit comporter deux en-têtes : X-API-KEY (votre clé d’API, émise par contact acheteur) et OW-KEY (le secret partagé OpenWrench émis avec la clé). La clé restreint automatiquement chaque requête à votre entreprise. Vous ne voyez que vos propres données. Les requêtes auxquelles il manque l’un des en-têtes renvoient 401.
Pour obtenir une clé d’API et un secret partagé, communiquez avec support@useopenwrench.com. Utilisez GET /v1/buyer/me pour inspecter l’identité (contact, établissement, entreprise) associée à votre clé. Les clés n’expirent pas d’elles-mêmes. Pour en effectuer la rotation, demandez au soutien une nouvelle paire clé/secret partagé, déployez la nouvelle paire, puis demandez au soutien de révoquer l’ancienne.
La section API Équipes internes plus bas dans cet onglet utilise une clé d’API partenaire distincte. Votre clé acheteur ne s’authentifiera pas contre les endpoints /v1/partners/. Voir l’introduction à l’API Équipes internes pour les détails.

​
Limites de débit

10 requêtes par fenêtre de 20 secondes par clé. Au-delà, vous recevrez 429 Too Many Requests : attendez au moins 20 secondes avant de réessayer, et espacez les tâches en arrière-plan (par exemple les exports paginés complets) pour qu’elles demeurent sous la limite.

​
Garder les bons de travail synchronisés

Si votre intégration réplique les bons de travail dans un autre système (un outil de billetterie, un ERP, un entrepôt de données), bâtissez-la sur la poussée, pas sur le sondage :
  1. Enregistrez un endpoint webhook. OpenWrench envoie les événements workorder.create, workorder.status_update et workorder.new_note à mesure qu’ils se produisent.
  2. À chaque événement, récupérez ce seul bon de travail avec GET /v1/buyer/work_order/work_orders/{id}.
  3. Utilisez GET /v1/buyer/work_order/work_orders pour les requêtes ponctuelles, le chargement initial unique et la réconciliation occasionnelle, avec un filtre étroit et une petite page.
Ne sondez pas l’endpoint de liste selon un horaire pour trouver les bons de travail nouveaux ou modifiés. C’est la lecture la plus coûteuse de l’API, elle est lente sur les gros comptes et elle rivalise avec votre vrai travail pour la limite de débit. Voir Bons de travail pour les détails.

​
Enveloppe de réponse

Réponses à entité unique :
Les réponses de liste ajoutent un count total :
Erreurs :
401 signifie une clé manquante ou invalide; 400 couvre les entrées incorrectes, les filtres invalides et les refus de permission; 429 correspond à la limite de débit.

​
Pagination et filtrage

Les endpoints de liste acceptent offset, limit (par défaut 10, maximum 25), sort_by et order (asc | desc). Les autres paramètres de requête sont traités comme des filtres de champ. Passez un nom de champ avec une valeur (séparez plusieurs valeurs par des virgules) pour filtrer l’ensemble de résultats. La page de référence de chaque endpoint liste ses filtres notables.

​
Formats de date

La plupart des horodatages sont des chaînes ISO 8601 avec décalage (par exemple 2026-08-14T13:05:22.000-07:00); certains champs d’horodatage de base de données sont sérialisés au format yyyy-MM-dd HH:mm:ss.S. Les dates simples sont au format yyyy-MM-dd. Lorsque vous envoyez des dates-heures, utilisez le format ISO 8601.

​
Guides détaillés

Les guides de cet onglet parcourent chaque partie de l’API en profondeur, avec des charges utiles, des modèles de statut et des modèles d’intégration :

Bons de travail

Créer, filtrer, réaffecter, clôturer. Modèle de statut, notes et types de problèmes.

Webhooks

Événements de création de bon de travail, de changement de statut et de nouvelle note envoyés à votre endpoint.

Appels de service

Preuves de visite : journaux de travail, temps de travail réel et détails des techniciens.

Actifs et emplacements

Emplacements, régions, types d’actifs, modèles, compteurs et suivi des frigorigènes.

Factures

Pipeline d’approbation, synchronisation avec les comptes fournisseurs, exports aplatis et mises à jour en lot.

Soumissions et propositions

Lire les soumissions des fournisseurs et les réconcilier avec les factures.

Entretien préventif

Lire les calendriers, sauter des exécutions et piloter l’entretien préventif depuis un planificateur externe.

Réseau de fournisseurs

Interroger votre réseau et classer les fournisseurs du réseau privé pour la répartition.

Inspections de site

Visites d’inspection et bons de travail issus de leurs constats.

Fichiers et pièces jointes

Téléverser une fois, référencer partout, télécharger les preuves.

Compte et utilitaires

Ping, identité de la clé, approvisionnement d’utilisateurs et taux de change.