Referência da API

A API do Aether365 permite-lhe aceder programaticamente a dados de análise, acionar análises, gerir tenants e conduzir o AI Pilot - gerar, rever e aplicar remediação automatizada, ler sinais de risco de identidade e reforçar políticas.

Grupos de endpoints

Área	O que abrange
Scans	Acionar e listar análises de conformidade e exposição
Results	Ler resultados individuais de análises
AI Pilot	Gerar, rever e aplicar planos de remediação automatizada
Threat Alerts	Sinais de risco de identidade e contenção de utilizadores com um clique
Policies	Ler o estado das políticas e reforçar políticas em lista de permissões
Tenants	Ler e atualizar o perfil do tenant
Connections	Gerir tenants Microsoft 365 ligados
Scheduled Scans	Automatizar análises recorrentes

URL Base

https://api.aether365.io

Todos os endpoints são relativos a este URL base.

Autenticação

A API utiliza autenticação Bearer token. Inclua um token JWT válido no cabecalho Authorization de cada pedido:

Authorization: Bearer <token>

Os tokens são emitidos pelo sistema de autenticação do Aether365. Consulte Autenticação para detalhes sobre como obter um token.

Formato de Resposta

Todas as respostas da API utilizam uma estrutura JSON consistente.

Resposta de Sucesso

{
  "success": true,
  "data": {}
}

Para endpoints de lista:

{
  "success": true,
  "data": [],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

Para endpoints de ação (acionar, eliminar):

{
  "success": true,
  "data": null
}

Resposta de Erro

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description",
    "details": {}
  }
}

Códigos de Estado HTTP

Código	Significado
200	Sucesso
201	Recurso criado
400	Pedido inválido - parâmetros em falta ou malformados
401	Autenticação necessária ou token inválido
403	Acesso negado - violação de isolamento de tenant
404	Recurso não encontrado
409	Conflito - por exemplo, uma análise já está em execução
429	Limite do plano atingido
500	Erro interno do servidor

Códigos de Erro

Código	Descrição
AUTH_MISSING_TOKEN	Cabecalho Authorization não presente
AUTH_INVALID_TOKEN	Token não pode ser verificado
AUTH_EXPIRED_TOKEN	Token expirou
TENANT_NOT_FOUND	Tenant não existe
TENANT_NOT_CONNECTED	Consentimento Microsoft não concluído
SCAN_NOT_FOUND	ID de análise não existe
SCAN_ALREADY_RUNNING	Uma análise já está em execução para este tenant
SCAN_PLAN_LIMIT_REACHED	Quota de análises para o plano atual esgotada
VALIDATION_ERROR	Corpo do pedido ou parâmetros de consulta inválidos
INTERNAL_ERROR	Erro inesperado do servidor

Limites de Taxa

A API está limitada a 120 pedidos por minuto. Exceder o limite de taxa devolve 429 Too Many Requests. O cabecalho Retry-After indica quantos segundos aguardar antes de tentar novamente.