Mokapen API-documentatie

Organisaties

De meeste Mokapen-eindpunten zijn gericht op één organisatie. De organisatiecontext wordt gedefinieerd in zowel de URL als het toegangstoken.

Organisatie-ID in de URL

Eindpunten op entiteiten volgen dit patroon:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Vervang {org_id} door de numerieke ID van uw organisatie. Sommige integraties kunnen een gecodeerde organisatie-ID gebruiken; de API accepteert beide formaten, indien ondersteund.

Organisatiebeperking op het token

Tokens die zijn uitgegeven voor ontwikkelaarstoepassingen bevatten een organization_id (opgeslagen in het tokenrecord en aanwezig in het OAuth-antwoord).

Wanneer u een eindpunt aanroept met {org_id} in de URL, verifieert Mokapen dat het token is geautoriseerd voor die organisatie. Als de organisatie in de URL niet overeenkomt met de organisatie in het token, antwoordt de API 403 Verboden.

  • Privé-apps — de organisatie wordt automatisch ingesteld op het genereren van tokens (gebaseerd op de actieve organisatie in het ontwikkelaarsdashboard).
  • App openbaar — eindgebruiker selecteert organisatie tijdens OAuth-toestemming.

Eindpunt van de organisatielijst

Om organisaties toegankelijk te maken voor de gebruiker of voor een geverifieerde integratie:

GET /api/v1/organisaties

Premium organisatie en API-toegang

De beschikbaarheid van API's en dagelijkse quota zijn afhankelijk van het Mokapen-abonnement van uw organisatie. Zie API-limieten voor limieten per abonnement.

Begin met werken en bespaar tijd.

of
Boek een demo

Heeft u hulp nodig?