Mokapen API dokumentace

Chcete-li začít

Před voláním jakéhokoli koncového bodu API vytvořte a nakonfigurujte aplikaci ve svém účtu Mokapen Developer.

Přehled

Mokapen API jsou REST. Každý požadavek musí obsahovat platnou hlavičku Authorization: Bearer , pokud není uvedeno jinak.

Základní URL: https://mokapen.com/api

Předpona verze API: v1 (příklad: /api/v1/{org_id}/contacts).

Krok 1 — Vytvořte aplikaci

Přihlaste se do Mokapen, otevřete svou organizaci a přejděte na Účet → Vývojář → Moje aplikace. Odtud můžete zobrazit existující aplikace nebo vytvořit novou.

Mokapen podporuje dva typy aplikací:

  • App public — navržená pro integrace používané více uživateli Mokapen. Použijte tok autorizačního kódu OAuth 2.0. Uživatelé vaši aplikaci autorizují a vybírají, které organizaci udělí přístup.
  • Soukromé aplikace — navržené pro interní automatizaci ve vaší organizaci. Použijte grant client_credentials. Tokeny se generují z vývojářského panelu bez přesměrování OAuth na koncového uživatele.

Požadavky na aplikaci

Pole Aplikace je veřejná Soukromé aplikace
Název společnosti Povinný Povinný
Web společnosti Povinný Povinný
Název aplikace Povinný Povinný
Logo společnosti Povinný Povinný
Adresy URL přesměrování Povinný Není vyžadováno
Vyhrazený uživatel Není vyžadováno Povinný
Zúčastněné strany Volitelný Volitelný
U soukromých aplikací pole Dedicated User definuje, kterého člena organizace integrace představuje. Přístup k rozhraní API respektuje oprávnění a rozsah tohoto uživatele.

Krok 2 — Vyberte rozsahy rozhraní API

Po vyplnění údajů aplikace klikněte na Continue a vyberte potřebné rozsahy (oprávnění) a poté aplikaci uložte.

Pouze rozsahy povolené během nastavení lze vyžádat v autorizaci (veřejná aplikace) nebo zahrnout do tokenů (soukromá aplikace).

Krok 3 — Aktivace a přihlašovací údaje

soukromé aplikace se aktivují ihned po vytvoření. Vlastníci a správci organizací je mohou kdykoli deaktivovat nebo znovu aktivovat na stránce aplikace.

veřejné aplikace začínají jako Čeká na schválení. Před aktivací aplikace Mokapen zkontroluje požadované rozsahy. Když je stav Active, otevřete záložku Credentials a získejte client_id a klientský_tajný tok.

Pokud změníte obory u již aktivní veřejné aplikace, vrátí se zpět do stavu čekání na schválení a stávající tokeny budou odvolány.

Uložte své přihlašovací údaje bezpečně. Nikdy nevystavujte tajný klíč klienta v kódu na straně klienta nebo ve veřejných úložištích.

Další kroky

Začněte pracovat a ušetříte čas.

nebo
Zarezervujte si demo

Potřebujete pomoc?