Skip to main content

Authentication

Every request is authenticated by your API key, sent in the X-Api-Key header.

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

How to create the key​

Users with the administrator profile create and manage keys in the Manager Panel, under Configurações > API de integração (Settings > Integration API).

  1. In the menu, open Configurações > API de integração and, in the Chave de integração (integration key) section, click Nova Chave (New key).

    Integration API menu and New key button

  2. Give the key a name.

    Key name

  3. Click Criar (Create).

    Create button

  4. Copy the key and store it in a safe place before clicking Fechar (Close): for security reasons, it cannot be viewed again later.

    Copy the key and close

Keep the key secret

Do not share the key and do not expose it in code that runs in the browser (client-side).

Authentication errors​

StatusMessageWhen it happens
401Missing API KeyThe X-Api-Key header was not sent.
401Invalid API KeyThe key does not exist or was removed.
403Account blockedThe account is blocked.
403Account expiredThe account has expired.
403Account plan not allowedThe account plan does not allow integration.

The body of these responses is { "message": "<message>" }. See the error catalog.