Autenticação

Toda requisição é autenticada pela sua chave de API, enviada no header X-Api-Key.

curl https://carchost.fieldcontrol.com.br/customers \
  -H "X-Api-Key: SUA_CHAVE" \
  -H "User-Agent: MinhaIntegracao/1.0"

Como criar a chave

Usuários com perfil de administrador criam e gerenciam as chaves no Painel do Gestor, em Configurações > API de integração.

1. No menu, abra Configurações > API de integração e, na seção Chave de integração, clique em Nova Chave.

   

2. Dê um nome para a chave.

   

3. Clique em Criar.

   

4. Copie a chave e guarde em um local seguro antes de clicar em Fechar: por segurança, ela não pode ser visualizada depois.

   

Mantenha a chave em segredo

Não compartilhe a chave e não a exponha em código que roda no navegador (client-side).

Erros de autenticação

Status	Mensagem	Quando acontece
401	Missing API Key	O header X-Api-Key não foi enviado.
401	Invalid API Key	A chave não existe ou foi removida.
403	Account blocked	A conta está bloqueada.
403	Account expired	A conta expirou.
403	Account plan not allowed	O plano da conta não permite integração.

O corpo dessas respostas é { "message": "<mensagem>" }. Veja o catálogo de erros.