Atualizado em 16 de outubro de 2026

Pré-requisitos

  • Acesso a uma instalação do miCore, como https://empresa.exemplo.com.
  • Um usuário com permissão para criar credenciais de API.
  • Uma ferramenta para enviar requisições HTTP: cURL, Postman ou a linguagem da sua integração.

1. Gere uma credencial

No painel do miCore, acesse Links úteis → Credenciais API. Crie uma credencial e selecione somente os escopos exigidos pela integração.

Para uma integração de confiança que precisa fazer tudo, ligue Acesso total: a credencial recebe o escopo *, que vale para todos os escopos, inclusive os que forem criados depois. Só é aceito com responsável administrador do sistema; a permissão dele no painel e os módulos contratados continuam valendo. GET /me mostra scopes: ["*"]. Use uma credencial por integração, para poder revogar só ela.

2. Configure o ambiente

Os exemplos desta documentação leem a URL base e o token de variáveis de ambiente.

Terminal
export MICORE_BASE_URL="https://empresa.exemplo.com/api/v1"
export MICORE_TOKEN="cole-o-token-aqui"

3. Faça a primeira requisição

Consulte GET /me para confirmar a instalação, a aplicação e o usuário responsável pela credencial.

cURL
curl "$MICORE_BASE_URL/me" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

4. Verifique as capacidades

Consulte GET /capabilities antes de exibir ações. A resposta considera os escopos da credencial, as permissões do responsável e os recursos ativos no tenant.

cURL
curl "$MICORE_BASE_URL/capabilities" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Erros comuns

StatusVerifique
401Se o Bearer Token foi enviado, está ativo e ainda não expirou.
403Se a credencial possui o escopo e o usuário responsável possui a permissão exigida.
429Se a integração ultrapassou a cota por minuto configurada para a credencial.
Precisa de ajuda?Use o request ID e abra um chamado no miCore se encontrar uma divergência.