Mokapen API dokumentáció

Szervezetek

A legtöbb Mokapen-végpont egyetlen szervezetre vonatkozik. A szervezeti környezet mind az URL-ben, mind a hozzáférési tokenben meg van határozva.

Szervezeti azonosító az URL-ben

Az entitások végpontjai a következő mintát követik:

SZEREZZE BE /api/v1/{org_id}/contacts
SZEREZZE BE /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Cserélje ki a {org_id} karakterláncot szervezete numerikus azonosítójával. Egyes integrációk titkosított szervezetazonosítót használhatnak; az API mindkét formátumot elfogadja, ahol támogatott.

A token szervezeti megszorítása

A fejlesztői alkalmazások számára kiadott tokenek tartalmaznak egy organization_id értéket (a tokenrekordba mentve, és az OAuth-válaszban jelen van).

Amikor olyan végpontot hív meg, amelynek URL-jében a {org_id} szerepel, a Mokapen ellenőrzi, hogy a token engedélyezett-e az adott szervezet számára. Ha az URL-ben szereplő szervezet nem egyezik a tokenben szereplő szervezettel, az API a következőt válaszolja: 403 Tiltott.

  • Privát alkalmazások – a szervezet automatikusan be van állítva a token generálására (a fejlesztői irányítópulton lévő aktív szervezet alapján).
  • Nyilvános alkalmazás – a végfelhasználó az OAuth hozzájárulása során választja ki a szervezetet.

Szervezeti lista végpontja

A szervezetek hozzáférésének biztosítása a felhasználó számára vagy hitelesített integráció:

Szerezze be az /api/v1/organisations

Prémium szervezés és API hozzáférés

Az API elérhetősége és a napi kvóták a szervezet Mokapen-tervétől függenek. A tervenkénti korlátokról lásd: API-korlátok.

Kezdjen el dolgozni, miközben időt takarít meg.

vagy
Foglaljon bemutatót

Segítségre van szüksége?