Pular para o conteúdo principal

Autenticação

Toda requisição leva uma chave de API no cabeçalho X-API-Key.

curl -H "X-API-Key: mgi_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     https://seu-servidor/api/v1/integration/connection

Conseguir uma chave​

As chaves são geradas dentro do Mover.Glass, no cadastro do integrador. Peça a quem administra a sua instalação.

Duas coisas para saber antes de pedir:

A chave aparece uma vez só. Guardamos apenas o hash dela, então não temos como recuperá-la depois — se ela se perder, a única saída é revogar e gerar outra. Copie direto para onde ela vai viver.

Use uma chave por instalação. Não uma por empresa. Se uma máquina for comprometida ou desativada, aquela chave é revogada sem incomodar ninguém. Cada chave tem um nome, então a lista continua legível daqui a um ano.

GET /api/v1/integration/connection​

Conferir se funciona.

Antes de qualquer coisa, confirme a URL e a chave:

curl -H "X-API-Key: mgi_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     https://seu-servidor/api/v1/integration/connection
{
  "connected": true,
  "authenticatedByApiKey": true,
  "apiKeyId": 12,
  "email": "integrador@cliente.com",
  "serverUtc": "2026-09-18T14:02:11Z"
}

Vale ligar isso no seu próprio monitoramento. Ele responde três perguntas de uma vez: o servidor está acessível, a chave é válida, e os relógios batem. A maioria dos problemas de integração que parecem misteriosos é um desses três.

O apiKeyId diz qual chave autenticou. Quando várias instalações dividem um servidor, é por esse número que se distingue uma da outra numa conversa de suporte.

Quando uma chave para de funcionar​

Chave revogada ou inválida devolve 401, com corpo que não vale a pena interpretar.

Trate 401 como não repetir. Nada em mandar a mesma requisição de novo vai mudar a resposta — a chave precisa ser trocada. Repetir uma chave ruim em laço é como uma integração acaba bloqueada.

Cuidar da chave​

A chave é uma credencial. O mesmo cuidado de uma senha:

  • Nunca no controle de versão, nunca numa URL, nunca numa linha de log
  • Em variável de ambiente, cofre de segredos ou arquivo de configuração cifrado
  • Trocar se alguém que tinha acesso sair

Se uma chave vazar, peça a revogação. Revogar é imediato, e gerar a substituta leva segundos.