Autenticação

Toda requisição deve incluir a chave de API da sua organização. As chaves são emitidas pela Notrus e restritas a uma única organização — a API só retorna os dados da sua organização.

O cabeçalho `apikey`

Envie sua chave no cabeçalho de requisição apikey em toda chamada:

http

apikey: <your-api-key>

Exemplo

bash

curl https://api.hom.notrus.ai/graphql \
  -H "Content-Type: application/json" \
  -H "apikey: $NOTRUS_API_KEY" \
  -d '{"query":"{ conversations(first: 1) { edges { node { conversationId } } } }"}'

Como funciona

Toda requisição é autenticada a partir da sua chave de API. Como a chave já identifica sua organização, esse escopo é aplicado automaticamente a toda consulta — não há nada a configurar nem parâmetro de organização a passar. Você sempre recebe os dados da sua organização, e somente os dela.

Entrando no developer portal

O Console da API não usa chave de API nenhuma. Faça login com a conta Keycloak da sua organização e o console já roda toda consulta restrita à sua organização — não há chave para copiar, colar, ou versionar por acidente. Isso é separado do cabeçalho apikey acima: aquele é para as suas próprias integrações (curl, serviços de backend, scripts), não para explorar a API interativamente.

Mantenha sua chave segura

Trate a chave como uma senha. Não a versione no controle de código.
Envie-a somente por HTTPS (todos os endpoints são exclusivamente HTTPS).
Para acesso programático (curl, scripts, integrações de backend) sua chave de API é a credencial a usar — veja Console da API para como o próprio portal se autentica.

Chave ausente ou inválida

Uma requisição com chave de API ausente ou não reconhecida retorna um erro UNAUTHENTICATED — veja Erros.