Documentazione API Mokapen

Per iniziare

Prima di chiamare qualsiasi endpoint API, crea e configura un'applicazione nel tuo account Developer Mokapen.

Panoramica

Le API Mokapen sono REST. Ogni richiesta deve includere un header valido Authorization: Bearer <access_token>, salvo diversa indicazione.

Base URL: https://mokapen.com/api

Prefisso versione API: v1 (esempio: /api/v1/{org_id}/contacts).

Passo 1 — Crea un'applicazione

Accedi a Mokapen, apri la tua organizzazione e vai su Account → Developer → Le mie applicazioni. Da lì puoi vedere le app esistenti o crearne una nuova.

Mokapen supporta due tipi di applicazione:

  • App public — pensata per integrazioni usate da più utenti Mokapen. Usa il flusso OAuth 2.0 authorization code. Gli utenti autorizzano la tua app e scelgono a quale organizzazione concedere l'accesso.
  • App private — pensata per automazioni interne alla tua organizzazione. Usa il grant client_credentials. I token si generano dalla dashboard Developer senza redirect OAuth per l'utente finale.

Requisiti dell'applicazione

Campo App public App private
Nome azienda Obbligatorio Obbligatorio
Sito web azienda Obbligatorio Obbligatorio
Nome applicazione Obbligatorio Obbligatorio
Logo azienda Obbligatorio Obbligatorio
Redirect URL Obbligatorio Non richiesto
Utente dedicato Non richiesto Obbligatorio
Stakeholder Opzionale Opzionale
Per le app private, il campo Utente dedicato definisce quale membro dell'organizzazione rappresenta l'integrazione. L'accesso API rispetta i permessi e gli scope di quell'utente.

Passo 2 — Seleziona gli scope API

Dopo aver compilato i dati dell'applicazione, clicca Continua per scegliere gli scope (permessi) necessari, poi salva l'applicazione.

Solo gli scope abilitati in fase di setup possono essere richiesti in autorizzazione (app public) o inclusi nei token (app private).

Passo 3 — Attivazione e credenziali

Le applicazioni private vengono attivate subito dopo la creazione. Owner e admin dell'organizzazione possono disattivarle o riattivarle in qualsiasi momento dalla pagina dell'app.

Le applicazioni public partono come In attesa di approvazione. Mokapen revisiona gli scope richiesti prima di attivare l'app. Quando lo stato è Active, apri la tab Credentials per ottenere client_id e client_secret e avviare il flusso OAuth authorization code.

Se modifichi gli scope su un'applicazione public già attiva, torna in attesa di approvazione e i token esistenti vengono revocati.

Conserva le credenziali in modo sicuro. Non esporre mai il client secret nel codice client-side o in repository pubblici.

Prossimi passi

Hai bisogno di aiuto?