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

Обхвати и разрешения

Обхватите контролират кои API ресурси вашето приложение може да чете или пише. Всеки обхват има ниво на достъп, свързано с ролите на членове на организацията.

метли Ниво на достъп Описание Позволени роли
tasks.read Обществен Read tasks owner, user, member, limited_user, guest, admin
tasks.write семена Create or update tasks owner, user, admin
projects.read Обществен Read projects owner, user, member, limited_user, guest, admin
projects.write семена Create or update projects owner, user, admin
appointments.read Обществен Read appointments owner, user, member, limited_user, guest, admin
appointments.write семена Create or update appointments owner, user, admin
bookings.read Обществен Read bookings owner, user, member, limited_user, guest, admin
bookings.write семена Create or update bookings owner, user, admin
contacts.read Обществен Read contact data owner, user, member, limited_user, guest, admin
contacts.write семена Create or update contacts owner, user, admin
companies.read Обществен Read company data owner, user, member, limited_user, guest, admin
companies.write семена Create or update companies owner, user, admin
deals.read Обществен Read deal data owner, user, member, limited_user, guest, admin
deals.write семена Create or update deals owner, user, admin
quotes.read Обществен Read quote data owner, user, member, limited_user, guest, admin
quotes.write семена Create or update quotes owner, user, admin
orders.read Обществен Read order data owner, user, member, limited_user, guest, admin
orders.write семена Create or update orders owner, user, admin
services.read Обществен Read service data owner, user, member, limited_user, guest, admin
services.write семена Create or update services owner, user, admin
products.read Обществен Read product data owner, user, member, limited_user, guest, admin
products.write семена Create or update products owner, user, admin
tickets.read Обществен Read ticket data owner, user, member, limited_user, guest, admin
tickets.write семена Create or update tickets owner, user, admin
documents.read Обществен Read document data owner, user, member, limited_user, guest, admin
documents.write семена Create or update documents owner, user, admin
campaigns.read Обществен Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write семена Create or update campaigns owner, user, admin
profile.write семена Update profile roles and preferences owner, user, admin
users.write семена Manage teams and team members owner, user, admin

Как работят обхватите

При създаването на приложение изберете обхватите, които то може да изисква. По време на изпълнение токенът трябва да включва обхвата, изискван от крайната точка (напр. tasks.read за изброяване на задачи).

За публични приложения (на трети страни) Mokapen също така проверява дали ролята на удостоверения потребител в организацията е разрешена за всяко ниво на обхват.

  • Public — достъпно за собственик, администратор, потребител, член, ограничен_потребител и гост.
  • Полу-ограничен — достъпен за собственик и потребител.
  • Restricted — достъпно само за собственици (включва profile.write и users.write за управление на профил и екип).

Обхват на заявката

Обществено приложение: Подайте обхвати като списък, разделен с интервали в URL адреса за оторизиране на OAuth и заявката за токен.

Частни приложения: обхватите се вземат от конфигурацията на приложението по време на генерирането на токени.

scope=tasks.read tasks.write contacts.read companies.read

Започнете работа, като спестявате време.

или
Резервирайте демо

имате нужда от помощ