Mokapen API dokumentácia

Ak chcete začať

Pred volaním akéhokoľvek koncového bodu API vytvorte a nakonfigurujte aplikáciu vo svojom účte vývojára Mokapen.

Prehľad

Mokapen API sú REST. Každá požiadavka musí obsahovať platnú hlavičku Autorization: Bearer , pokiaľ nie je uvedené inak.

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

Predpona verzie API: v1 (príklad: /api/v1/{org_id}/contacts).

Krok 1 — Vytvorte aplikáciu

Prihláste sa do Mokapen, otvorte svoju organizáciu a prejdite na Účet → Vývojár → Moje aplikácie. Odtiaľ môžete vidieť existujúce aplikácie alebo vytvoriť novú.

Mokapen podporuje dva typy aplikácií:

  • App public — navrhnutá pre integráciu používanú viacerými používateľmi Mokapen. Použite tok autorizačného kódu OAuth 2.0. Používatelia autorizujú vašu aplikáciu a vyberajú, ktorej organizácii udelia prístup.
  • Súkromné ​​aplikácie — navrhnuté pre internú automatizáciu vo vašej organizácii. Použite grant client_credentials. Tokeny sa generujú z panela vývojára bez presmerovaní OAuth na koncového používateľa.

Požiadavky na aplikáciu

Pole Verejná aplikácia Súkromné ​​aplikácie
Názov spoločnosti Povinné Povinné
Webová stránka spoločnosti Povinné Povinné
Názov aplikácie Povinné Povinné
Logo spoločnosti Povinné Povinné
Presmerovať adresy URL Povinné Nevyžaduje sa
Vyhradený používateľ Nevyžaduje sa Povinné
zainteresované strany Voliteľné Voliteľné
V prípade súkromných aplikácií pole Vyhradený používateľ definuje, ktorého člena organizácie integrácia predstavuje. Prístup k API rešpektuje povolenia a rozsah tohto používateľa.

Krok 2 – Vyberte rozsahy API

Po vyplnení údajov aplikácie kliknite na Continue, aby ste si vybrali potrebné rozsahy (oprávnenia), potom aplikáciu uložte.

V autorizácii (verejná aplikácia) alebo zahrnuté v tokenoch (súkromná aplikácia) možno požadovať iba rozsahy povolené počas nastavenia.

Krok 3 — Aktivácia a poverenia

súkromné ​​aplikácie sa aktivujú ihneď po vytvorení. Vlastníci a správcovia organizácií ich môžu kedykoľvek deaktivovať alebo znova aktivovať na stránke aplikácie.

verejné aplikácie začínajú ako Čaká na schválenie. Mokapen pred aktiváciou aplikácie skontroluje požadované rozsahy. Keď je stav Active, otvorte kartu Credentials, aby ste získali client_id a th autorizačný tok klienta.

Ak zmeníte rozsahy už aktívnej verejnej aplikácie, vráti sa späť do stavu čakania na schválenie a existujúce tokeny sa odvolajú.

Bezpečne si uložte svoje poverenia. Nikdy nezverejňujte tajomstvo klienta v kóde na strane klienta alebo vo verejných archívoch.

Ďalšie kroky

Začnite pracovať a zároveň ušetrite čas.

alebo
Objednajte si demo

Potrebujete pomoc?