Mokapen API-documentatie

Om aan de slag te gaan

Voordat u een API-eindpunt aanroept, moet u een applicatie maken en configureren in uw Mokapen-ontwikkelaarsaccount.

Overzicht

Mokapen API's zijn REST. Elk verzoek moet een geldige header Authorization: Bearer bevatten, tenzij anders aangegeven.

Basis-URL: https://mokapen.com/api

Voorvoegsel API-versie: v1 (bijvoorbeeld: /api/v1/{org_id}/contacts).

Stap 1 — Maak een applicatie

Log in op Mokapen, open uw organisatie en ga naar Account → Ontwikkelaar → Mijn applicaties. Van daaruit kunt u bestaande apps bekijken of een nieuwe maken.

Mokapen ondersteunt twee soorten toepassingen:

  • App public — ontworpen voor integraties die door meerdere Mokapen-gebruikers worden gebruikt. Gebruik de OAuth 2.0-autorisatiecodestroom. Gebruikers autoriseren uw app en kiezen aan welke organisatie zij toegang willen verlenen.
  • Privé-apps — ontworpen voor interne automatisering binnen uw organisatie. Gebruik de client_credentials-toekenning. Tokens worden gegenereerd vanuit het ontwikkelaarsdashboard zonder OAuth-omleidingen naar de eindgebruiker.

Toepassingsvereisten

Veld App openbaar Privé-apps
Bedrijfsnaam Verplicht Verplicht
Bedrijfswebsite Verplicht Verplicht
Naam van applicatie Verplicht Verplicht
Bedrijfslogo Verplicht Verplicht
Omleidings-URL's Verplicht Niet vereist
Toegewijde gebruiker Niet vereist Verplicht
Belanghebbenden Optioneel Optioneel
Voor privé-apps definieert het veld Dedicated User welk organisatielid de integratie vertegenwoordigt. API-toegang respecteert de rechten en reikwijdte van die gebruiker.

Stap 2 — Selecteer API-scopes

Nadat u de applicatiegegevens heeft ingevuld, klikt u op Doorgaan om de benodigde bereiken (machtigingen) te kiezen en slaat u vervolgens de applicatie op.

Alleen bereiken die tijdens de installatie zijn ingeschakeld, kunnen worden aangevraagd in autorisatie (openbare app) of opgenomen in tokens (privé-app).

Stap 3 — Activering en inloggegevens

privétoepassingen worden onmiddellijk na het maken geactiveerd. Organisatie-eigenaren en beheerders kunnen deze op elk gewenst moment deactiveren of opnieuw activeren via de app-pagina.

public-applicaties beginnen als In afwachting van goedkeuring. Mokapen beoordeelt de vereiste scopes voordat de app wordt geactiveerd. Wanneer de status Actief is, opent u het tabblad Credentials om client_id en client_secret op te halen en start u de OAuth-autorisatiecodestroom.

Als u het bereik van een reeds actieve openbare toepassing wijzigt, wacht deze weer op goedkeuring en worden bestaande tokens ingetrokken.

Bewaar uw inloggegevens veilig. Geef het clientgeheim nooit bloot in code aan de clientzijde of in openbare opslagplaatsen.

Volgende stappen

Begin met werken en bespaar tijd.

of
Boek een demo

Heeft u hulp nodig?