Ir para o conteúdo
Voltar para a documentação
Guia operacional gerado e rastreável

Chaves de API

/settings/api-keys

Treinamento da tela Chaves de API, com fluxo operacional, permissões e APIs relacionadas à rota.

Abrir na plataforma

Validação

Código inspecionado e limite HTTP testado sem credenciais.

Permissões

automations.manage

Integração

11 endpoint(s) relacionados automaticamente à tela.

1

Entenda o objetivo da tela

Use Chaves de API para consultar e operar o módulo configuration dentro do escopo autorizado. Antes de agir, confirme o tenant, o registro e os filtros exibidos.

2

Localize a área de trabalho

A interface apresenta as áreas: Chave criada:, Chaves cadastradas, Autenticação via x-api-key, Health Analytics API. Leia indicadores e filtros antes de iniciar qualquer ação.

3

Execute somente a ação necessária

As principais ações identificadas são: Já salvei, Nova chave, Criar chave segura, Cancelar, Revogar. Botões disponíveis continuam sujeitos às permissões e validações da API.

4

Confira o resultado

Revise mensagens, contagens e o registro afetado. Para suporte técnico, relacione a operação aos 11 endpoint(s) listados neste guia.

Áreas e ações

Elementos identificados na tela

Chaves de API

Chave criada:

Chaves cadastradas

Autenticação via x-api-key

Health Analytics API

Boas práticas de segurança

Já salvei

Nova chave

Criar chave segura

Cancelar

Revogar

Controle de acesso

Permissões e escopo

Permissões

automations.manage

Entitlements

Nenhum localizado

Módulo

configuration

Interface → API

Rotas relacionadas ao fluxo

A correlação é feita a partir das chamadas encontradas na página. Componentes delegados podem adicionar outras rotas.

MétodoEndpointFinalidadePermissãoEvidência
GET/api/v1/api-keysList all API keys for the tenantautomations.manage401 · limite de autenticação testado
POST/api/v1/api-keysCreate a new API keyautomations.manageCódigo inspecionado; runtime não exercitado
DELETE/api/v1/api-keys/:keyIdRevoke an API keyautomations.manageCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/contractsList Contractsapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/contracts/:contractId/benchmarkGet Benchmarkapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/contracts/:contractId/recommendationsGet Recommendationsapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/contracts/:contractId/risk-scoreGet Risk Scoreapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/contracts/:contractId/snapshotGet Snapshotapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/market-trendsGet Market Trendsapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/portfolio/alertsGet Portfolio Alertsapi-keyCódigo inspecionado; runtime não exercitado
GET/api/v1/health-analytics/external/statusStatusapi-keyCódigo inspecionado; runtime não exercitado

Limite de validação

Esta tela ainda não recebeu validação autenticada individual no navegador. O guia foi produzido a partir do código, dos guards e das chamadas de API, sem presumir funcionamento em runtime.

Confirmar operação

Informe os detalhes