Códigos de Erro
Todos os erros da API devolvem uma estrutura JSON consistente:
json
{
"success": false,
"error": {
"code": "SNAKE_CASE_ERROR_CODE",
"message": "Human-readable description",
"details": {}
}
}Autenticação
| Código | HTTP | Significado | Correção |
|---|---|---|---|
AUTH_MISSING_TOKEN | 401 | Sem cabecalho Authorization no pedido | Inclua Authorization: Bearer <token> em todos os pedidos |
AUTH_INVALID_TOKEN | 401 | O JWT não pode ser verificado | Verifique se o token não esta malformado ou truncado |
AUTH_EXPIRED_TOKEN | 401 | O JWT expirou | Obtenha um novo token iniciando sessão novamente ou atualizando a sessão |
AUTH_INSUFFICIENT_SCOPE | 403 | A conta autenticada não tem permissão para está ação | Verifique se está a utilizar uma conta com a função necessária |
Autorização
| Código | HTTP | Significado | Correção |
|---|---|---|---|
TENANT_ACCESS_DENIED | 403 | Pedido tentou aceder a dados de outro tenant | Isto não deveria ocorrer em utilização normal - contacte o suporte se o observar |
AUTH_INSUFFICIENT_SCOPE | 403 | Permissões insuficientes para está ação | Verifique se está a utilizar uma conta com a função necessária |
Tenant
| Código | HTTP | Significado | Correção |
|---|---|---|---|
TENANT_NOT_FOUND | 404 | Não existe conta de tenant para este utilizador | Crie uma conta em app.aether365.io |
TENANT_NOT_CONNECTED | 400 | O consentimento administrativo do Microsoft 365 não foi concluído | Ligue um tenant através de Definições > Ligações |
Análises
| Código | HTTP | Significado | Correção |
|---|---|---|---|
SCAN_NOT_FOUND | 404 | O ID da análise não existe ou pertence a outro tenant | Verifique o ID da análise |
SCAN_ALREADY_RUNNING | 409 | Já existe uma análise em execução para este tenant | Aguarde que a análise atual sejá concluída |
SCAN_PLAN_LIMIT_REACHED | 429 | Quota de análises esgotada | Aguarde até ao próximo período de faturação ou contacte o suporte |
SERVICE_UNAVAILABLE | 503 | A plataforma está em modo de manutenção | Verifique o estado e tente novamente quando a manutenção terminar |
Ligações
| Código | HTTP | Significado | Correção |
|---|---|---|---|
CONNECTION_NOT_FOUND | 404 | O ID da ligação não existe | Verifique o ID da ligação |
CANNOT_REMOVE_LAST_CONNECTION | 409 | Não é possível remover a única ligação restante | Adicione outra ligação antes de remover está |
Membros da Equipa
| Código | HTTP | Significado | Correção |
|---|---|---|---|
MEMBER_LIMIT_REACHED | 429 | Limite de membros atingido | Contacte o suporte para adicionar mais membros |
MEMBER_ALREADY_EXISTS | 409 | O email já tem um convite ativo ou pendente | Verifique a lista atual de membros |
Análises Agendadas
| Código | HTTP | Significado | Correção |
|---|---|---|---|
SCAN_PLAN_LIMIT_REACHED | 429 | Limite de agendamentos personalizados atingido | Elimine um agendamento existente ou contacte o suporte |
Validação
| Código | HTTP | Significado |
|---|---|---|
VALIDATION_ERROR | 400 | Corpo do pedido ou parâmetro de consulta inválido. O campo details lista os campos específicos inválidos. |
Erros do Servidor
| Código | HTTP | Significado | Correção |
|---|---|---|---|
INTERNAL_ERROR | 500 | Erro inesperado do servidor | Tente novamente o pedido. Se o erro persistir, contacte o suporte com o ID do pedido dos cabecalhos da resposta. |
Limites de Taxa
Quando excede o limite de taxa da API, a API devolve:
json
{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Retry after 60 seconds."
}
}Estado HTTP: 429 Too Many Requests Cabecalho: Retry-After: 60
Limites de taxa atuais: 120 pedidos por minuto por chave API.