Mokapen API -dokumentaatio

Yleiskatsaus

Mokapen API:t ovat REST. Jokaisessa pyynnössä on oltava kelvollinen Avaltuutus: Bearer -otsikko, ellei toisin mainita.

Perus-URL-osoite: ZZTOK 0Z https://mokapen.com/api

API-version etuliite: v1 (esimerkki: /api/v1/{org_id}/contacts).

Vaihe 1 – Luo sovellus

Kirjaudu Mokapeniin, avaa organisaatiosi ja mene kohtaan Atili → Kehittäjä → Omat sovellukset. Sieltä näet olemassa olevat sovellukset tai voit luoda uuden.

Mokapen tukee kahdenlaisia ​​sovelluksia:

• App public — suunniteltu useiden Mokapen-käyttäjien käyttämiin integraatioihin. Käytä OAuth 2.0 -valtuutuskoodikulkua. Käyttäjät valtuuttavat sovelluksesi ja valitsevat, mille organisaatiolle he myöntävät käyttöoikeuden.
• Yksityinen sovellus — suunniteltu organisaatiosi sisäiseen automatisointiin. Käytä client_credentials-avustusta. Tokenit luodaan kehittäjien hallintapaneelista ilman OAuth-uudelleenohjauksia loppukäyttäjälle.

Sovelluksen vaatimukset

Vaihe 2 – Valitse API-laajuudet

Kun olet täyttänyt hakemuksen tiedot, napsauta Continue valitaksesi tarvittavat laajuudet (oikeudet) ja tallenna sovellus.

Vain määrityksen aikana käyttöön otettuja laajuuksia voidaan pyytää valtuutuksessa (julkinen sovellus) tai sisällyttää tunnuksiin (yksityinen sovellus).

Vaihe 3 – Aktivointi ja kirjautumistiedot

Yksityiset -sovellukset aktivoidaan heti luomisen jälkeen. Organisaation omistajat ja järjestelmänvalvojat voivat poistaa ne käytöstä tai aktivoida uudelleen milloin tahansa sovellussivulta.

public-hakemukset alkavat nimellä Odottaa hyväksyntää. Mokapen tarkistaa tarvittavat laajuudet ennen sovelluksen aktivointia. Kun tila on Active, avaa Credentials-välilehti saadaksesi client_id ja client_secret ja aloita OAuth-valtuutuskoodi.

Jos muutat jo aktiivisen julkisen sovelluksen laajuuksia, se palaa odottamaan hyväksyntää ja olemassa olevat tunnukset peruutetaan.

Säilytä tunnistetietosi turvallisesti. Älä koskaan paljasta asiakkaan salaisuutta asiakaspuolen koodissa tai julkisissa arkistoissa.

Seuraavat vaiheet

• Public apps → follow the Authentication guide (OAuth authorization code).
• Private apps → generate a token from the Credentials tab, then see Private app tokens.
• Browse endpoints in the API Reference.