Autenticação

Como autenticar suas requisições e gerar a sua API Key no painel web.

A API é autenticada por API Key. Envie sua chave no header X-Api-Key em todas as requisições:

X-Api-Key: SUA_CHAVE_AQUI

Exemplo com cURL:

curl -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://app.saikoobtech.com.br/api/v1/servicos"
🔒

Requisições sem o header, ou com uma chave inválida ou revogada, recebem o erro 401 UNAUTHORIZED.

Como gerar uma API Key

O token é gerado diretamente no painel web, em poucos cliques.

Pré-requisitos

  • Ter acesso ao painel web em https://app.saikoobtech.com.br/app.
  • Ter permissão de Segurança (a mesma usada para gerenciar Usuários do Sistema). Caso não veja o menu, solicite ao administrador da sua conta.

Passo a passo

  1. Faça login em https://app.saikoobtech.com.br/app.
  2. No menu lateral, acesse Utilitários › Segurança › Chaves de API.
  3. Clique em Novo para abrir a janela de criação.
  4. Informe uma descrição que identifique a finalidade da chave (ex.: "Integração Agenda").
  5. Clique em Gerar chave. O sistema cria uma chave única de 64 caracteres e a exibe na tela.
  6. Copie a chave imediatamente e clique em Concluir.
⚠️

A chave é exibida uma única vez. Após fechar a janela, ela passa a aparecer mascarada (apenas os 4 primeiros e 4 últimos caracteres) e não há como recuperá-la. Se perder, basta gerar uma nova.

Gerenciar e revogar chaves

Na própria tela Chaves de API você pode:

  • Visualizar as chaves criadas, com descrição, data de criação e status (Ativo/Inativo).
  • Revogar uma chave a qualquer momento — ela é inativada e deixa de funcionar imediatamente.
  • Criar quantas chaves precisar: use uma chave por integração, assim você revoga apenas a necessária sem afetar as demais.

Boas práticas de segurança

  • Nunca exponha a chave em código público, repositórios ou no front-end de aplicações.
  • Prefira armazenar a chave em variáveis de ambiente ou em um gerenciador de segredos.
  • Revogue imediatamente qualquer chave suspeita de vazamento e gere uma nova.

Did this page help you?