Mokapen API dokumentace

Organizace

Většina koncových bodů Mokapen je určena pro jednu organizaci. Kontext organizace je definován v adrese URL i v přístupovém tokenu.

ID organizace v adrese URL

Koncové body na entitách se řídí tímto vzorem:

ZÍSKEJTE /api/v1/{org_id}/contacts
ZÍSKEJTE /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Nahraďte {org_id} číselným ID vaší organizace. Některé integrace mohou používat zašifrovaný identifikátor organizace; API přijímá oba formáty, pokud jsou podporovány.

Omezení organizace na tokenu

Tokeny vydané pro vývojářské aplikace zahrnují organization_id (uložené v záznamu tokenu a přítomné v odpovědi OAuth).

Když zavoláte koncový bod s {org_id} v URL, Mokapen ověří, že je token autorizován pro danou organizaci. Pokud se organizace v URL neshoduje s organizací v tokenu, API odpoví 403 Forbidden.

  • Soukromé aplikace — organizace je automaticky nastavena na generování tokenu (na základě aktivní organizace na panelu vývojáře).
  • App public — koncový uživatel vybere organizaci během souhlasu OAuth.

Koncový bod seznamu organizací

Chcete-li organizacím zpřístupnit uživatele nebo ověřenou integraci:

ZÍSKEJTE /api/v1/organizations

Prémiová organizace a přístup k API

Dostupnost API a denní kvóty závisí na plánu Mokapen vaší organizace. Viz API Limits pro limity na plán.

Potřebujete pomoc?