URL de base
/v1/supplier/.
Authentification
Chaque requête doit comporter deux en-têtes :X-API-KEY (votre clé d’API, émise par contact fournisseur) et OW-KEY (le secret partagé OpenWrench émis avec la clé). La clé restreint automatiquement chaque requête à votre établissement. Vous ne voyez que les bons de travail, factures et données qui vous appartiennent. Les requêtes auxquelles il manque l’un des en-têtes renvoient 401.
Limites de débit
10 requêtes par fenêtre de 20 secondes par clé. Au-delà, vous recevrez429 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
La plupart des intégrations fournisseur existent pour répliquer la file de bons de travail OpenWrench dans un autre système. Bâtissez cela sur la poussée, pas sur le sondage :- Enregistrez un endpoint webhook. OpenWrench envoie les événements
workorder.create,workorder.status_updateetworkorder.new_noteà mesure qu’ils se produisent. - À chaque événement, récupérez ce seul bon de travail avec
GET /v1/supplier/work_order/work_orders/{id}. - Utilisez
GET /v1/supplier/work_order/work_ordersuniquement pour le chargement initial unique et la réconciliation occasionnelle, avec un filtre étroit et une petite page.
Enveloppe de réponse
Réponses à entité unique :count total :
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 acceptentoffset, limit (par défaut 10, maximum 25), sort_by et order (asc | desc). Les paramètres de requête supplémentaires sont traités comme des filtres. Chaque endpoint prend en charge son propre ensemble de clés de filtre, et les clés qu’il ne reconnaît pas sont ignorées plutôt que rejetées. Les filtres à plusieurs valeurs utilisent une clé au pluriel avec des valeurs séparées par des virgules (statuses=TechScheduled,TechRescheduled). Pour les bons de travail, consultez la référence des filtres.
Formats de date
La plupart des horodatages sont des chaînes ISO 8601 avec décalage (par exemple2026-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 avec un T entre la date et l’heure et un décalage explicite. Une valeur séparée par une espace comme 2026-09-10 10:43:00+00:00 n’est pas au format ISO 8601 et est rejetée; envoyez plutôt 2026-09-10T10:43:00.000+00:00. UTC peut s’écrire +00:00 ou Z.
Les filtres de date des listes de factures, de propositions et de bons de travail font exception. Ils prennent MM/dd/yyyy HH:mm:ss, une heure locale sans décalage, par exemple 10/09/2026 00:00:00 :
- Fuseau horaire. Passez le paramètre de requête facultatif
timezonepour définir le fuseau dans lequel OpenWrench lit les valeurs. Utilisez un nom de fuseau IANA, commeAmerica/Chicago,America/New_YorkouUTC. Les noms sont sensibles à la casse. Sanstimezone, OpenWrench lit les valeurs en UTC. - Fuseaux rejetés. Les décalages fixes (
-05:00,GMT-5,Z,Etc/GMT+5), les abréviations (CST) et les noms inconnus renvoient400. - Aucun décalage dans la valeur. OpenWrench ignore un décalage comme
-05:00à la fin d’une valeur de filtre. Utilisez plutôttimezone. - Les valeurs mal formées renvoient
400. Une valeur qui ne correspond pas au format renvoie400, par exempleInvalid markedPaidAtStartDate. Expected format MM/dd/yyyy HH:mm:ss. Cela inclut les valeurs ISO 8601 (2026-10-09T00:00:00), les dates sans heure (10/09/2026) et les valeurs composées uniquement d’espaces. OpenWrench lit encore une valeur vide comme le 1er janvier 1970. - Bornes de fin. Les dates de fin des factures et des propositions couvrent toute la journée de fin : OpenWrench remplace l’heure par 23:59:59 à cette date dans le fuseau
timezone. Les dates de fin des bons de travail sont exactes, alors envoyez23:59:59pour inclure toute la journée. - Heure avancée. Une heure située dans l’heure sautée lors du passage à l’heure avancée est avancée de la durée de l’écart. Une heure située dans l’heure répétée lors du retour à l’heure normale désigne l’occurrence en heure normale, soit la deuxième.
Données de temps des techniciens
Les endpoints WrenchMode exposent le temps de travail et de conduite par technicien :GET /v1/supplier/wrench_mode/events/analytics/{fromDate}/{toDate} retourne un rollup conduite/travail/total par technicien (fenêtre limitée à 1 mois), et GET /v1/supplier/wrench_mode/events retourne le journal d’événements brut derrière celui-ci. Les expansions d’appel de service (/with_work_logs, /with_tech_details) donnent l’histoire par visite.
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
Recevoir, accepter ou refuser, statuts de pièces, ECD, pièces jointes et notes.
Webhooks
Nouveaux travaux, changements de statut et notes de l’acheteur envoyés à votre endpoint.
Appels de service
Planifier, s’enregistrer, quitter et définir le statut de fin.
WrenchMode
Analyses par technicien et journal d’événements bruts conduite/travail.
Soumissions et facturation
Soumettre des propositions, préparer des factures et publier avec un PDF.
Achats et inventaire
Des demandes d’achat aux commandes puis aux réceptions, catalogues et stock.
Données de référence
Entreprises acheteuses, emplacements, actifs et fonctionnement du masquage de données.
Fichiers et utilisateurs
Le magasin de fichiers derrière les pièces jointes et l’approvisionnement de techniciens.