Mokapen API dokumentation

For at komme i gang

Før du kalder et API-slutpunkt, skal du oprette og konfigurere en applikation på din Mokapen-udviklerkonto.

Oversigt

Mokapen API'er er REST. Hver anmodning skal indeholde en gyldig Aautorisation: Bærer header, medmindre andet er angivet.

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

API-versionspræfiks: v1 (eksempel: /api/v1/{org_id}/contacts).

Trin 1 — Opret en applikation

Log ind på Mokapen, åbn din organisation og gå til AKonto → Udvikler → Mine applikationer. Derfra kan du se eksisterende apps eller oprette en ny.

Mokapen understøtter to typer applikationer:

  • App public — designet til integrationer, der bruges af flere Mokapen-brugere. Brug OAuth 2.0-godkendelseskodeflowet. Brugere godkender din app og vælger, hvilken organisation de vil give adgang til.
  • Privat app — designet til intern automatisering i din organisation. Brug tildelingen client_credentials. Tokens genereres fra udvikler-dashboardet uden OAuth-omdirigeringer til slutbrugeren.

Ansøgningskrav

Felt App offentlig Private apps
Firmanavn Obligatorisk Obligatorisk
Virksomhedens hjemmeside Obligatorisk Obligatorisk
Applikationsnavn Obligatorisk Obligatorisk
Firmalogo Obligatorisk Obligatorisk
Omdiriger URL'er Obligatorisk Ikke påkrævet
Dedikeret bruger Ikke påkrævet Obligatorisk
Interessenter Valgfri Valgfri
For private apps definerer feltet DedicatedUser, hvilket organisationsmedlem integrationen repræsenterer. API-adgang respekterer denne brugers tilladelser og omfang.

Trin 2 — Vælg API-omfang

Når du har udfyldt applikationsdataene, skal du klikke på Continue for at vælge de nødvendige omfang (tilladelser), og derefter gemme applikationen.

Kun scopes aktiveret under opsætningen kan anmodes om i godkendelse (offentlig app) eller inkluderet i tokens (privat app).

Trin 3 — Aktivering og legitimationsoplysninger

private -applikationer aktiveres umiddelbart efter oprettelsen. Organisationsejere og -administratorer kan til enhver tid deaktivere eller genaktivere dem fra appsiden.

public-applikationer starter som Afventer godkendelse. Mokapen gennemgår de påkrævede omfang inden aktivering af appen. Når status er Active, skal du åbne fanen Credentials for at få client_id og client_secret og starte OAuth-autorisationskodeflowet.

Hvis du ændrer omfang på en allerede aktiv offentlig applikation, går den tilbage til at afvente godkendelse, og eksisterende tokens tilbagekaldes.

Opbevar dine legitimationsoplysninger sikkert. Afslør aldrig klienthemmeligheden i kode på klientsiden eller i offentlige arkiver.

Næste trin

Har du brug for hjælp?