Chaves de API e âmbitos

Uma chave de API permite que um script ou outro sistema chame a API do xEvolve sem iniciar sessão na consola. Cada chave tem âmbitos que limitam o que pode fazer.

Criar uma chave

Abra Chaves de API e escolha Nova chave.
Introduza um nome, marque os âmbitos necessários e, se quiser, defina uma validade em dias.
Copie a chave. Começa por xev_ e só é mostrada uma vez. O xEvolve guarda apenas um hash.

Envie a chave como token bearer para o seu espaço:

curl https://<workspace>.xevolve.io/api/v1/connections \
  -H "Authorization: Bearer xev_<key>"

Revogar uma chave tem efeito imediato. A criação e a revogação de chaves são escritas no registo de auditoria.

Regras

Uma chave só pode criar chaves cujos âmbitos estejam entre os seus. Pedir mais devolve 403.
Uma chamada sem o âmbito necessário devolve 403 com API key missing required scope.
Uma sessão de consola não é limitada por âmbitos; segue a função do utilizador.
As definições de autenticação multifator, a gestão de sessões, os eventos de início de sessão, o registo de service principals, os avatares, a política de retenção e o estado do teste só aceitam sessões de consola. As chaves de API recebem 403.

Âmbitos

Âmbito	Permite
`files:read`	Listar, pesquisar e descarregar ficheiros.
`files:write`	Carregar ficheiros.
`transfers:read`	Listar e ver transferências.
`transfers:write`	Criar, executar e cancelar transferências.
`connections:read`	Listar e ver ligações.
`connections:write`	Criar, editar, eliminar e testar ligações.
`data-rooms:read`	Listar e ver salas de dados.
`data-rooms:write`	Criar, editar e gerir salas de dados.
`schedules:read`	Listar agendamentos e o histórico de execuções.
`schedules:write`	Criar, editar, eliminar e executar agendamentos.
`watchers:read`	Listar vigilâncias de pastas.
`watchers:write`	Criar, editar e eliminar vigilâncias.
`workflows:read`	Listar workflows e o histórico de execuções.
`workflows:write`	Criar, editar, eliminar e executar workflows.
`parameters:read`	Listar e ver parâmetros globais.
`parameters:write`	Criar, editar e eliminar parâmetros globais.
`users:read`	Listar e ver utilizadores.
`users:write`	Editar e eliminar utilizadores.
`agents:read`	Listar e ver agentes geridos.
`agents:write`	Criar, editar, eliminar e testar agentes geridos.
`webhooks:read`	Listar webhooks e entregas.
`webhooks:write`	Criar, editar e eliminar webhooks.
`activity:read`	Ler o registo de atividade e os contadores do painel.
`notifications:read`	Ler as definições de notificação e o registo de notificações.
`notifications:write`	Editar ou testar as definições de notificação.
`api-keys:read`	Listar chaves de API.
`api-keys:write`	Criar e revogar chaves de API, dentro dos âmbitos que a chave que chama possui.

As chaves de API e os webhooks exigem o plano Team ou superior. Planos e limites indica os pedidos de API permitidos por mês.