Códigos de retorno
Códigos de retorno y error
| Código | Significado | Causa | Acción recomendada |
|---|---|---|---|
200 | Éxito | La solicitud se procesó. En el envoltorio JSON, status es 0. | — |
206 | Partial Content | El inicio de sesión exige una etapa de MFA. | Complete el desafío mediante el linkURL devuelto. |
400 | Bad Request | Parámetros o formato no válidos, credencial ausente, Basic enviado a una ruta que exige token Bearer o header CF-Turnstile-Response ausente. | Revise los parámetros, los headers y el cuerpo. |
401 | Unauthorized | Usuario inexistente, contraseña no válida, o token caducado o con firma, emisor o audiencia no válidos. | Verifique las credenciales u obtenga un nuevo token. |
403 | Forbidden | Regla de acceso del usuario (conexión bloqueada, ventana horaria, filtros, límite de sesiones), host distinto del configurado o token Turnstile rechazado. | Use el host informado por el administrador y verifique las reglas del usuario en la plataforma STCP. |
404 | Not Found | Archivo, enlace o recurso no encontrado, o enlace caducado. | Verifique el endpoint y si el enlace sigue siendo válido. |
405 | Method Not Allowed | El método HTTP no es compatible con el endpoint. | Use el método indicado en la Referencia de la API. |
500 | Internal Server Error | Falla interna. | Inténtelo de nuevo; si persiste, contacte al soporte. |
503 | Service Unavailable | Servicio externo de validación no disponible, como Cloudflare Turnstile. | Inténtelo de nuevo; si persiste, contacte al administrador. |
Envoltorio de respuesta
La mayoría de las operaciones responde con un objeto JSON con los campos siguientes, más los campos propios de cada operación:
| Campo | Descripción |
|---|---|
status | 0 en caso de éxito. |
description | Descripción del resultado. |
apiver | Versión de la API y del producto que respondieron (p. ej., v2 (9.0.1)). |
user | Usuario autenticado, cuando corresponde. |
time | Fecha y hora de la respuesta en el servidor. |
{
"status": 0,
"description": "<descripción devuelta por la API>",
"apiver": "v2 (9.0.1)",
"user": "<usuario>",
"time": "<fecha y hora>"
}El formato del cuerpo de error varía entre endpoints: trate primero el estado HTTP y, cuando exista, use la descripción devuelta. Los endpoints de token (/auth/token y /oauth2/token) usan el formato de error de OAuth 2.0 (error, error_description, error_uri). Vea Códigos y eventos de la API.