Mokapen API документация

Преглед

API на Mokapen са REST. Всяка заявка трябва да включва валидна заглавка Authorization: Bearer , освен ако не е указано друго.

Основен URL адрес: ZZTOK 0Z https://mokapen.com/api

Префикс на версията на API: v1 (пример: /api/v1/{org_id}/contacts).

Стъпка 1 — Създайте приложение

Влезте в Mokapen, отворете вашата организация и отидете на Aкаунт → Разработчик → Моите приложения. Оттам можете да видите съществуващи приложения или да създадете ново.

Mokapen поддържа два типа приложения:

• App public — предназначен за интеграции, използвани от множество потребители на Mokapen. Използвайте потока на кода за оторизация OAuth 2.0. Потребителите упълномощават вашето приложение и избират на коя организация да предоставят достъп.
• Частно приложение — предназначено за вътрешна автоматизация във вашата организация. Използвайте разрешението client_credentials. Токените се генерират от таблото за управление на програмиста без OAuth пренасочвания към крайния потребител.

Изисквания за кандидатстване

Стъпка 2 — Изберете обхвати на API

След като попълните данните за приложението, щракнете върху Continue, за да изберете необходимите обхвати (разрешения), след което запазете приложението.

Само обхвати, активирани по време на настройката, могат да бъдат заявени в упълномощаване (публично приложение) или включени в токени (частно приложение).

Стъпка 3 — Активиране и идентификационни данни

private приложенията се активират веднага след създаването. Собствениците и администраторите на организацията могат да ги деактивират или активират отново по всяко време от страницата на приложението.

public приложенията започват като Очаква одобрение. Mokapen преглежда необходимите обхвати, преди да активира приложението. Когато състоянието е Active, отворете раздела Credentials, за да получите client_id и client_secret и стартирайте потока на кода за оторизация на OAuth.

Ако промените обхватите на вече активно публично приложение, то се връща към изчакване на одобрение и съществуващите токени се отменят.

Съхранявайте своите идентификационни данни сигурно. Никога не излагайте тайната на клиента в код от страна на клиента или в публични хранилища.

Следващи стъпки

• Public apps → follow the Authentication guide (OAuth authorization code).
• Private apps → generate a token from the Credentials tab, then see Private app tokens.
• Browse endpoints in the API Reference.