Errores

Gestione errores de la API y códigos de respuesta

Manejo de errores

La API de SurveyNinja utiliza códigos de estado HTTP estándar para indicar el éxito o el fracaso de las solicitudes. Todos los errores se devuelven en un formato JSON unificado.

Descarga la versión en markdown de la sección "Manejo de errores" para usar en ChatGPT / otros LLMs:

Formato de error

Estructura de la respuesta de error

Todos los errores se devuelven en un formato unificado con un código de error, mensaje y detalles adicionales.

Ejemplo de error
{ "success": false, "error": { "code": "validation_error", "message": "The 'title' field is required", "details": { "field": "title", "value": null, "constraint": "required" }, "request_id": "req_1234567890", "timestamp": "2024-01-15T10:30:00Z" } }

Códigos de estado HTTP

Respuestas exitosas

Código Descripción Uso
200 OK Solicitud GET o PUT exitosa
201 Creado Solicitud POST exitosa
204 Sin contenido Solicitud DELETE exitosa

Errores del cliente (4xx)

Código Descripción Motivo
400 Solicitud incorrecta Parámetros de solicitud no válidos
401 No autorizado Token ausente o no válido
403 Prohibido Permisos de acceso insuficientes
404 No encontrado Recurso no encontrado
422 Entidad no procesable Errores de validación
429 Demasiadas solicitudes Límite de tasa superado

Errores del servidor (5xx)

Código Descripción Acción
500 Error interno del servidor Reintenta la solicitud más tarde
502 Puerta de enlace incorrecta Indisponibilidad temporal del servicio
503 Servicio no disponible El servicio no está disponible temporalmente

Códigos de error de la API

Errores de autenticación

unauthorized

Token de autorización no válido

{ "status": false, "error": { "code": "unauthorized", "message": "Invalid authorization token" } }

token_expired

El token ha expirado y debe renovarse

access_denied

El acceso al recurso está denegado

access_denied_to_folder

El acceso a la carpeta está denegado

Errores de validación

validation_error

Error de validación de datos

{ "success": false, "error": { "code": "validation_error", "message": "Validation errors", "details": { "errors": [ { "field": "title", "message": "The field is required" }, { "field": "questions", "message": "Must contain at least one question" } ] } } }

invalid_question_type

Tipo de pregunta no compatible

Errores de recursos

not_found

Recurso no encontrado

answer_not_found

Respuesta no encontrada

workspace_not_found

Espacio de trabajo no encontrado