API kľúče

Ako sa prepnúť do modulu MonivioIntegration, vytvoriť API kľúč s presnými oprávneniami a bezpečne ho odovzdať integrácii.

O funkcii: Prepojenia a API
API kľúče

Kedy to budete potrebovať

Keď chcete Monivio prepojiť s iným systémom - e-shopom, skladom, vlastnou aplikáciou alebo účtovným programom. API kľúč je heslo tejto integrácie: dokazuje, že volania na REST API patria vašej organizácii.

Info:

API kľúče a webhooky sú dostupné od plánu Solo; na pláne Free ich nevytvoríte. Plán zmeníte v Nastavenia → Predplatné (viď Zmena tieru predplatného).

Kľúč vytvorený na platenom pláne po prechode na Free nefunguje: REST API s ním odpovie chybou 403 s kódom TIER_REQUIRED. Po návrate na plán s REST API funguje ten istý kľúč znova, nový netreba.

Toto je technická časť určená vývojárom. Popis endpointov a formátov nájdete v API dokumentácii (posledná položka menu modulu Integrácia).

Krok 1: Prepnite sa do modulu MonivioIntegration

API kľúče nie sú v bežnom menu s faktúrami. Kliknite vľavo hore na prepínač platformy (nad ľavým menu, predvolene ukazuje MonivioDocuments) a vyberte MonivioIntegration - modul so synchronizáciou, API a webhookmi.

Bez prepnutia platformy API kľúče ani webhooky v menu neuvidíte.

Ľavé menu sa prepne a v sekcii Integrácia nájdete API kľúče, Webhooky, Analytics a API dokumentáciu.

Krok 2: Vytvorte API kľúč

V sekcii Integrácia → API kľúče kliknite na Vytvoriť API kľúč.

Pri každom kľúči vidíte typ, oprávnenia a kedy bol naposledy použitý.

V dialógu vyplníte:

PolePopis
NázovAby ste vedeli, ktorá integrácia kľúč používa (napr. „E-shop“)
TypLen čítanie alebo Čítanie a zápis
OprávneniaKu ktorým oblastiam má kľúč prístup - doklady, kontakty, náklady, katalóg, kategórie, tagy, číselné rady, webhooky a ďalšie
ExpiráciaNikdy, 30 dní, 90 dní, 1 rok alebo vlastný dátum
Oprávnenia nastavujte po oblastiach - integrácia má vidieť len to, čo naozaj potrebuje.

Krok 3: Kľúč si hneď uložte

Po vytvorení sa kľúč zobrazí jediný raz. Skopírujte si ho do správcu hesiel alebo do konfigurácie svojho systému - po zatvorení okna ho už Monivio nezobrazí, v databáze je uložený len jeho odtlačok.

Ak si kľúč nestihnete uložiť, jediná cesta je vytvoriť nový.
Pozor:

Ak kľúč uniknol, okamžite ho revokujte. Prestane fungovať hneď a nedá sa znovu aktivovať - pre integráciu vytvorte nový. Revokovaný kľúč zostáva v zozname aj s históriou; Zmazať odstráni aj samotný záznam.

Krok 4: Sledujte, či a ako sa kľúč používa

Na karte kľúča vidíte typ, oprávnenia, kedy vyprší a kedy bol naposledy použitý (alebo „Nikdy“), a jeho stav: Aktívny, Revokovaný alebo Expirovaný. Zoznam viete filtrovať na Všetky, Aktívne a Revokované a hľadať v ňom podľa názvu. Pod zoznamom je odkaz na API dokumentáciu.

Kľúč môžete v menu Akcie upraviť (názov, oprávnenia, expirácia - typ sa meniť nedá a tajná hodnota ostáva rovnaká), revokovať alebo zmazať. Podrobnejší pohľad ponúka položka Dashboard na vrchu menu modulu MonivioIntegration: graf volaní REST API za posledné dni, počet chýb a prehľad aktívnych kľúčov a webhookov.

Graf sa naplní po prvom volaní REST API vaším kľúčom.
Tip:

Pre každú integráciu vytvorte samostatný kľúč. Keď jeden systém odpojíte alebo unikne, revokujete len jeho kľúč a ostatné integrácie bežia ďalej.

Čo ďalej?

Často kladené otázky

Bol tento článok užitočný?

Súvisiace články