Documentação da API Mokapen

Organizações

A maior parte dos endpoints do Mokapen é scoped a uma única organização. O contexto da organização fica definido tanto na URL quanto no token de acesso.

Organization ID na URL

Os endpoints das entidades seguem este padrão:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Troque {org_id} pelo ID numérico da organização. Algumas integrações podem usar um identificador de organização cifrado; a API aceita os dois formatos onde houver suporte.

Vínculo da organização no token

Os tokens emitidos para aplicativos developer incluem um organization_id (salvo no registro do token e presente na resposta OAuth).

Quando você chama um endpoint com {org_id} na URL, o Mokapen verifica se o token está autorizado para aquela organização. Se a organização na URL não coincidir com a do token, a API responde 403 Forbidden.

  • App private — a organização é definida automaticamente na geração do token (com base na organização ativa no dashboard Developer).
  • App public — o usuário final escolhe a organização durante o consentimento OAuth.

Endpoint de lista de organizações

Para obter as organizações acessíveis ao usuário ou à integração autenticada:

GET /api/v1/organizations

Premium da organização e acesso à API

Disponibilidade da API e cotas diárias dependem do plano Mokapen da organização. Veja Limites da API para os limites por plano.

Comece a trabalhar economizando tempo.

ou
Agendar uma demo

Preciso de ajuda?