Mokapen API dokumentation

För att komma igång

Innan du anropar någon API-slutpunkt, skapa och konfigurera en applikation i ditt Mokapen-utvecklarkonto.

Översikt

Mokapen API:er är REST. Varje begäran måste innehålla en giltig Auktorisation: Bärare -huvud, om inte annat anges.

Basadress: https://mokapen.com/api

API-versionsprefix: v1 (exempel: /api/v1/{org_id}/contacts).

Steg 1 — Skapa en applikation

Logga in på Mokapen, öppna din organisation och gå till Konto → Utvecklare → Mina applikationer. Därifrån kan du se befintliga appar eller skapa en ny.

Mokapen stöder två typer av applikationer:

  • App public — designad för integrationer som används av flera Mokapen-användare. Använd OAuth 2.0-auktoriseringskodflödet. Användare auktoriserar din app och väljer vilken organisation de ska ge åtkomst till.
  • Privata appar — designade för intern automatisering inom din organisation. Använd client_credentials-anslaget. Tokens genereras från utvecklarinstrumentpanelen utan OAuth-omdirigeringar till slutanvändaren.

Ansökningskrav

Fält App offentlig Privata appar
Företagsnamn Obligatorisk Obligatorisk
Företagets hemsida Obligatorisk Obligatorisk
Applikationsnamn Obligatorisk Obligatorisk
Företagets logotyp Obligatorisk Obligatorisk
Omdirigera webbadresser Obligatorisk Krävs inte
Dedikerad användare Krävs inte Obligatorisk
Intressenter Frivillig Frivillig
För privata appar definierar fältet Dedikerad användare vilken organisationsmedlem integrationen representerar. API-åtkomst respekterar användarens behörigheter och omfattning.

Steg 2 — Välj API-omfång

När du har fyllt i applikationsdata klickar du på Fortsätt för att välja nödvändiga omfattningar (behörigheter), och spara sedan applikationen.

Endast scopes aktiverade under installationen kan begäras i auktorisering (public app) eller inkluderas i tokens (privat app).

Steg 3 — Aktivering och inloggningsuppgifter

privata applikationer aktiveras omedelbart efter att de skapats. Organisationsägare och administratörer kan inaktivera eller återaktivera dem när som helst från appsidan.

public-applikationer börjar som Väntar på godkännande. Mokapen granskar de nödvändiga omfattningarna innan appen aktiveras. När statusen är Active, öppna fliken Credentials för att få client_id och client_secret och starta OAuth-auktoriseringskodflödet.

Om du ändrar omfång på en redan aktiv offentlig applikation går den tillbaka till att vänta på godkännande och befintliga tokens återkallas.

Förvara dina referenser säkert. Avslöja aldrig klienthemligheten i kod på klientsidan eller i offentliga arkiv.

Nästa steg

Behöver du hjälp?