Documentação da API Mokapen

Visão geral

As APIs do Mokapen são REST. Cada requisição deve incluir um header válido Authorization: Bearer <access_token>, salvo indicação em contrário.

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

Prefixo da versão da API: v1 (exemplo: /api/v1/{org_id}/contacts).

Passo 1 — Crie um aplicativo

Entre no Mokapen, abra sua organização e vá em Conta → Developer → Meus aplicativos. De lá você vê os apps existentes ou cria um novo.

O Mokapen oferece dois tipos de aplicativo:

• App public — pensado para integrações usadas por vários usuários Mokapen. Usa o fluxo OAuth 2.0 authorization code. Os usuários autorizam o seu app e escolhem a qual organização conceder o acesso.
• App private — pensado para automações internas da sua organização. Usa o grant client_credentials. Os tokens são gerados no dashboard Developer sem redirect OAuth para o usuário final.

Requisitos do aplicativo

Passo 2 — Selecione os scopes da API

Depois de preencher os dados do aplicativo, clique em Continuar para escolher os scopes (permissões) necessários e depois salve o aplicativo.

Só os scopes habilitados no setup podem ser pedidos na autorização (app public) ou incluídos nos tokens (app private).

Passo 3 — Ativação e credenciais

Os aplicativos private são ativados na hora da criação. Owner e admin da organização podem desativá-los ou reativá-los a qualquer momento na página do app.

Os aplicativos public começam como Aguardando aprovação. O Mokapen revisa os scopes pedidos antes de ativar o app. Quando o status for Active, abra a aba Credentials para obter client_id e client_secret e iniciar o fluxo OAuth authorization code.

Se você alterar os scopes de um aplicativo public já ativo, ele volta a aguardar aprovação e os tokens existentes são revogados.

Guarde as credenciais com segurança. Nunca exponha o client secret no código client-side ou em repositórios públicos.

Próximos passos

• App public → siga o guia de Autenticação (OAuth authorization code).
• App private → gere um token na aba Credentials e depois veja Tokens de apps private.
• Explore os endpoints na Referência da API.