Mokapen API -dokumentaatio

Organisaatiot

Useimmat Mokapen-päätepisteet on rajattu yhteen organisaatioon. Organisaation konteksti määritellään sekä URL-osoitteessa että käyttöoikeustunnuksessa.

Organisaation tunnus URL-osoitteessa

Entiteettien päätepisteet noudattavat tätä mallia:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Korvaa {org_id} organisaatiosi numeerisella tunnuksella. Jotkut integraatiot voivat käyttää salattua organisaation tunnistetta; API hyväksyy molemmat muodot, jos niitä tuetaan.

Tokenin organisaatiorajoitus

Kehittäjäsovelluksille myönnetyt tunnukset sisältävät organization_id (tallennettu tokentietueeseen ja näkyy OAuth-vastauksessa).

Kun kutsut päätepistettä, jonka URL-osoitteessa on {org_id}, Mokapen varmistaa, että tunnus on valtuutettu kyseiselle organisaatiolle. Jos URL-osoitteessa oleva organisaatio ei vastaa tunnuksessa olevaa organisaatiota, API vastaa 403 Forbidden.

  • App yksityinen — organisaatio asetetaan automaattisesti tunnuksen luomiseen (kehittäjien hallintapaneelin aktiivisen organisaation perusteella).
  • App public — loppukäyttäjä valitsee organisaation OAuth-suostumuksen aikana.

Organisaatioluettelon päätepiste

Organisaatioiden saaminen käyttäjien saataville tai todennettu integraatio:

GET /api/v1/organizations

Premium-organisaatio ja API-käyttöoikeus

API availability and daily quotas depend on the organization's Mokapen subscription plan. See Rate Limits for plan-based daily limits.

Aloita työskentely säästäen aikaa.

tai
Varaa demo

Tarvitsetko apua?