Veřejné API mWork365
Veřejné API mWork365 je REST API určené pro propojení s dalšími systémy — napojení na ERP nebo účetnictví, import a export dat a vlastní automatizace. Požadavky i odpovědi jsou ve formátu JSON.
Jak začít
Sekce “Jak začít”Volání API se autentizují přístupovým tokenem, který si vyměníte za dvojici Client ID a Secret Key. Tyto tři kroky vás dovedou k prvnímu funkčnímu volání:
Přístupové údajeVytvořte Client ID a Secret Key v nastavení firmy
→
PřihlášeníVyměňte je za přístupový token
→
První voláníOvěřte token a načtěte číselníky firmy
→
Základní URL
Sekce “Základní URL”Všechny endpointy v této referenci mají společný začátek. Cesty uvedené
u jednotlivých endpointů (například /customer) se připojují za tuto adresu:
https://app.mwork365.com/main/publicapiPravidla platná napříč API
Sekce “Pravidla platná napříč API”Tyhle stránky se vyplatí přečíst dřív, než začnete psát kód:
Datový modelEntity, jejich pole a vzájemné vazby
→
ID, externí ID a slugJak se na záznamy odkazovat z vašeho systému
→
Chybové stavyNávratové kódy a jejich význam
→
Podpis odchozích požadavkůOvěření webhooků a vlastních akčních tlačítek
→
Endpointy
Sekce “Endpointy”Reference je členěná podle entit — v postranním menu najdete tyto sekce:
ZákazníciZákazníci, adresy, kontaktní osoby a zařízení
→
ZařízeníSeznam zařízení napříč všemi zákazníky
→
ZakázkyZaložení, editace, dokončení a zrušení zakázek
→
VýjezdyPlánování, přeplánování a dokumenty výjezdů
→
PožadavkyPříchozí podněty, ze kterých vznikají zakázky
→
MateriálCeník materiálu — kategorie, dodavatelé, ceny
→
SkladySklady a pohyby skladových zásob
→
WebhookyUpozornění na události místo pravidelného dotazování
→
Vlastní akční tlačítkaTlačítko v aplikaci, které zavolá vaši službu
→
PřílohyNahrání souboru k záznamu a jeho stažení
→
Podpora
Sekce “Podpora”V případě problémů nebo požadavků na změny kontaktujte zákaznickou podporu.