Bas-URL
/v1/buyer/.
Autentisering
Varje förfrågan måste innehålla två rubriker:X-API-KEY (din API-nyckel, utfärdad per köparkontakt) och OW-KEY (den delade hemligheten från OpenWrench som utfärdas tillsammans med den). Nyckeln avgränsar automatiskt varje förfrågan till ditt företag. Du ser bara dina egna data. Förfrågningar som saknar någon av rubrikerna returnerar 401.
GET /v1/buyer/me för att inspektera identiteten (kontakt, anläggning, företag) bakom din nyckel.
Nycklar löper inte ut av sig själva. För att rotera en, begär ett nytt par nyckel/delad hemlighet från supporten, driftsätt det nya paret och be sedan supporten återkalla det gamla.
Sektionen Internal Teams API längre ner i den här fliken använder en separat partner-API-nyckel. Din köparnyckel autentiserar inte mot slutpunkterna under
/v1/partners/. Se Introduktion till Internal Teams API för detaljer.Hastighetsgränser
10 förfrågningar per 20-sekundersfönster per nyckel. Utöver det får du429 Too Many Requests. Vänta minst 20 sekunder innan du försöker igen, och sprid ut bakgrundsjobb (till exempel fullständiga sidindelade exporter) så att de håller sig under gränsen.
Hålla arbetsordrar synkroniserade
Om din integration speglar arbetsordrar till ett annat system (ett ärendehanteringsverktyg, ett ERP, ett datalager), bygg den på push, inte polling:- Registrera en webhook-slutpunkt. OpenWrench skickar händelserna
workorder.create,workorder.status_updateochworkorder.new_notenär de inträffar. - Vid varje händelse, hämta just den arbetsordern med
GET /v1/buyer/work_order/work_orders/{id}. - Använd
GET /v1/buyer/work_order/work_ordersför ad hoc-frågor, den engångsvisa initiala laddningen och tillfällig avstämning, med ett smalt filter och en liten sida.
Svarshöljet
Svar för enskilda entiteter:count:
401 betyder att en nyckel saknas eller är ogiltig; 400 täcker felaktig indata, felaktiga filter och behörighetsavslag; 429 är hastighetsgränsen.
Paginering och filtrering
List-slutpunkter accepteraroffset, limit (standard 10, max 25), sort_by och order (asc | desc). Ytterligare frågeparametrar behandlas som filter. Varje slutpunkt stöder sin egen uppsättning filternycklar, och nycklar den inte känner igen ignoreras i stället för att avvisas. Filter med flera värden använder en pluralnyckel med kommaseparerade värden (statuses=Unassigned,PendingApproval). För arbetsordrar, se filterreferensen.
Datumformat
De flesta tidsstämplar är ISO 8601-strängar med offset (till exempel2026-08-14T13:05:22.000-07:00); vissa databastidsstämpelfält serialiseras som yyyy-MM-dd HH:mm:ss.S. Rena datum är yyyy-MM-dd. När du skickar datum-tider, använd ISO 8601.
Datumfilter i faktura-, förslags- och arbetsorderlistorna är undantaget. De tar MM/dd/yyyy HH:mm:ss, en lokal klocktid utan offset, till exempel 10/09/2026 00:00:00:
- Tidszon. Skicka den valfria frågeparametern
timezoneför att ange vilken zon OpenWrench läser värdena i. Använd ett IANA-zonnamn, somAmerica/Chicago,America/New_YorkellerUTC. Namnen är skiftlägeskänsliga. Utantimezoneläser OpenWrench värdena i UTC. - Avvisade zoner. Fasta offset (
-05:00,GMT-5,Z,Etc/GMT+5), förkortningar (CST) och okända namn returnerar400. - Ingen offset i värdet. OpenWrench ignorerar en offset som
-05:00i slutet av ett filtervärde. Användtimezonei stället. - Felformaterade värden returnerar
400. Ett värde som inte matchar formatet returnerar400, till exempelInvalid markedPaidAtStartDate. Expected format MM/dd/yyyy HH:mm:ss. Det gäller även ISO 8601-värden (2026-10-09T00:00:00), datum utan tid (10/09/2026) och värden som bara består av mellanslag. OpenWrench läser fortfarande ett tomt värde som 1 januari 1970. - Slutgränser. Slutdatum för fakturor och förslag täcker hela slutdagen: OpenWrench ersätter tiden med 23:59:59 på det datumet i
timezone. Slutdatum för arbetsordrar är exakta, så skicka23:59:59för att ta med hela dagen. - Sommartid. En tid i den överhoppade timmen vid övergång till sommartid flyttas framåt med glappets längd. En tid i den upprepade timmen vid övergång till normaltid avser förekomsten i normaltid, alltså den andra.
Detaljerade guider
Guiderna i den här fliken går igenom varje del av API:et i detalj, med nyttolaster, statusmodeller och integrationsmönster:Arbetsordrar
Skapa, filtrera, tilldela om, avsluta. Statusmodell, anteckningar och problemtyper.
Webhooks
Händelser för skapad arbetsorder, statusändring och ny anteckning skickade till din slutpunkt.
Servicebesök
Besöksbevis: arbetsloggar, faktisk arbetstid och teknikeruppgifter.
Tillgångar och platser
Platser, regioner, tillgångstyper, modeller, mätare och köldmediespårning.
Fakturor
Godkännandeflödet, AP-synk, plattade exporter och massuppdateringar.
Offerter och förslag
Läs leverantörsofferter och stäm av dem mot fakturor.
Planerat underhåll
Läs scheman, hoppa över körningar och driv PM från en extern schemaläggare.
Leverantörsnätverk
Sök i ditt nätverk och rangordna privata nätverksleverantörer för utskick.
Platsbesiktningar
Genomgångar och arbetsordrar som skapas av deras iakttagelser.
Filer och bilagor
Ladda upp en gång, referera överallt, ladda ner bevis.
Konto och verktyg
Ping, nyckelidentitet, användarprovisionering och växelkurser.