Mokapen API dokumentáció

Áttekintés

A Mokapen API-k REST. Minden kérésnek tartalmaznia kell egy érvényes Authorization: Bearer fejlécet, hacsak nincs másképp jelezve.

Alap URL: https://mokapen.com/api

API verzió előtagja: v1 (példa: /api/v1/{org_id}/contacts).

1. lépés – Hozzon létre egy alkalmazást

Jelentkezzen be a Mokapenbe, nyissa meg szervezetét, és lépjen a Fiók → Fejlesztő → Saját alkalmazások menüpontra. Innen megtekintheti a meglévő alkalmazásokat, vagy létrehozhat újat.

A Mokapen kétféle alkalmazást támogat:

• App public – több Mokapen-felhasználó által használt integrációkhoz készült. Használja az OAuth 2.0 engedélyezési kódfolyamatot. A felhasználók engedélyezik az alkalmazást, és kiválasztják, hogy melyik szervezetnek adnak hozzáférést.
• Privát alkalmazások – a szervezeten belüli belső automatizáláshoz tervezték. Használja a client_credentials engedélyt. A tokenek a fejlesztői irányítópultról jönnek létre, anélkül, hogy OAuth-átirányításokat végeznének a végfelhasználóhoz.

Pályázati követelmények

2. lépés – Válassza ki az API-hatóköröket

A jelentkezési adatok kitöltése után kattintson a Tovább gombra a szükséges hatókörök (jogosultságok) kiválasztásához, majd mentse el az alkalmazást.

Csak a beállítás során engedélyezett hatóköröket lehet kérni az engedélyezésben (nyilvános alkalmazás), vagy csak a tokenekben szerepeltetni (privát alkalmazás).

3. lépés – Aktiválás és hitelesítő adatok

A privát alkalmazások a létrehozás után azonnal aktiválódnak. A szervezetek tulajdonosai és rendszergazdái bármikor deaktiválhatják vagy újraaktiválhatják őket az alkalmazás oldalán.

A public alkalmazások a következővel kezdődnek: Jóváhagyásra vár. A Mokapen az alkalmazás aktiválása előtt áttekinti a szükséges hatóköröket. Ha az állapot Aktív, nyissa meg a Credentials lapot a client_id és ⟦uth10⟧client_secret⟧ engedélyezésének elindításához.

Ha módosítja a hatóköröket egy már aktív nyilvános alkalmazáson, az visszaáll jóváhagyásra, és a meglévő tokenek visszavonásra kerülnek.

Tárolja biztonságosan hitelesítő adatait. Soha ne fedje fel az ügyfél titkát az ügyféloldali kódban vagy nyilvános tárolókban.

Következő lépések

• Az alkalmazás nyilvános → kövesse a Hitelesítési útmutatót (OAuth engedélyezési kód).
• Privát alkalmazások → generáljon egy tokent a Hitelesítési adatok lapon, majd tekintse meg a Privát alkalmazásjogkivonatok részt.
• Fedezze fel a végpontokat a API-referencia részben.