Autenticación

Toda solicitud se autentica con su clave de API, enviada en el header X-Api-Key.

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

Cómo crear la clave

Los usuarios con perfil de administrador crean y gestionan las claves en el Panel del Gestor, en Configurações > API de integração (Configuración > API de integración).

1. En el menú, abra Configurações > API de integração y, en la sección Chave de integração (clave de integración), haga clic en Nova Chave (Nueva clave).

   

2. Póngale un nombre a la clave.

   

3. Haga clic en Criar (Crear).

   

4. Copie la clave y guárdela en un lugar seguro antes de hacer clic en Fechar (Cerrar): por seguridad, no se podrá ver después.

   

Mantenga la clave en secreto

No comparta la clave y no la exponga en código que se ejecuta en el navegador (client-side).

Errores de autenticación

Estado	Mensaje	Cuándo ocurre
401	Missing API Key	No se envió el header X-Api-Key.
401	Invalid API Key	La clave no existe o fue eliminada.
403	Account blocked	La cuenta está bloqueada.
403	Account expired	La cuenta venció.
403	Account plan not allowed	El plan de la cuenta no permite integración.

El cuerpo de estas respuestas es { "message": "<mensaje>" }. Consulte el catálogo de errores.