Mokapen API dokumentácia

organizácie

Väčšina koncových bodov Mokapen je zameraná na jednu organizáciu. Kontext organizácie je definovaný v adrese URL aj v prístupovom tokene.

ID organizácie vo webovej adrese

Koncové body entít sa riadia týmto vzorom:

ZÍSKAJTE /api/v1/{org_id}/contacts
ZÍSKAJTE /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Nahraďte {org_id} číselným ID vašej organizácie. Niektoré integrácie môžu používať zašifrovaný identifikátor organizácie; API akceptuje oba formáty, ak sú podporované.

Organizačné obmedzenie tokenu

Tokeny vydané pre vývojárske aplikácie zahŕňajú organization_id (uložené v zázname tokenu a prítomné v odpovedi OAuth).

Keď zavoláte koncový bod s {org_id} v URL, Mokapen overí, že token je autorizovaný pre danú organizáciu. Ak sa organizácia v URL nezhoduje s organizáciou v tokene, API odpovie 403 Forbidden.

  • Private Apps — organizácia je automaticky nastavená na generovanie tokenov (na základe aktívnej organizácie na paneli vývojára).
  • App public — koncový používateľ vyberie organizáciu počas súhlasu OAuth.

Koncový bod zoznamu organizácií

Ak chcete organizáciám sprístupniť používateľa alebo overenú integráciu:

GET /api/v1/organizations

Prémiová organizácia a prístup k API

Dostupnosť API a denné kvóty závisia od plánu Mokapen vašej organizácie. Pozrite si Limity API pre limity na plán.

Potrebujete pomoc?