Códigos de retorno
Códigos de retorno e erro
| Código | Significado | Causa | Ação recomendada |
|---|---|---|---|
200 | Sucesso | A requisição foi processada. No envelope JSON, status é 0. | — |
206 | Partial Content | O login exige uma etapa de MFA. | Conclua o desafio pelo linkURL retornado. |
400 | Bad Request | Parâmetros ou formato inválidos, credencial ausente, Basic enviado a uma rota que exige token Bearer ou header CF-Turnstile-Response ausente. | Revise parâmetros, headers e corpo. |
401 | Unauthorized | Usuário inexistente, senha inválida, token expirado ou com assinatura, emissor ou público inválidos. | Verifique as credenciais ou obtenha um novo token. |
403 | Forbidden | Regra de acesso do usuário (conexão bloqueada, janela de horário, filtros, limite de sessões), host diferente do configurado ou token Turnstile rejeitado. | Use o host informado pelo administrador e verifique as regras do usuário na plataforma STCP. |
404 | Not Found | Arquivo, link ou recurso não encontrado, ou link expirado. | Confira o endpoint e se o link ainda é válido. |
405 | Method Not Allowed | O método HTTP não é suportado no endpoint. | Use o método indicado na Referência da API. |
500 | Internal Server Error | Falha interna. | Tente novamente; se persistir, acione o suporte. |
503 | Service Unavailable | Serviço externo de validação indisponível, como o Cloudflare Turnstile. | Tente novamente; se persistir, acione o administrador. |
Envelope de resposta
A maioria das operações responde com um objeto JSON com os campos abaixo, acrescidos dos campos próprios de cada operação:
| Campo | Descrição |
|---|---|
status | 0 em caso de sucesso. |
description | Descrição do resultado. |
apiver | Versão da API e do produto que responderam (ex.: v2 (9.0.1)). |
user | Usuário autenticado, quando aplicável. |
time | Data e hora da resposta no servidor. |
{
"status": 0,
"description": "<descrição retornada pela API>",
"apiver": "v2 (9.0.1)",
"user": "<usuario>",
"time": "<data e hora>"
}O formato do corpo de erro varia entre endpoints: trate primeiro o status HTTP e, quando houver, use a descrição retornada. Os endpoints de token (/auth/token e /oauth2/token) usam o formato de erro do OAuth 2.0 (error, error_description, error_uri). Veja Códigos e eventos da API.