Estructura de Respuesta del Servidor
La API Siigo Pyme devuelve respuestas en formato JSON, permitiendo interpretar y gestionar los resultados de cada solicitud de manera estructurada.
Ejemplo de respuesta JSON
{ "statusCode": 200, "status": "success", "message": "Operación realizada con éxito", "data": {}}Descripción de los campos
| Campo | Valores posibles | Descripción |
|---|---|---|
statusCode | 200, 201, 400, 401, 404, 500 | Código de estado HTTP indicando el resultado de la solicitud. |
status | success, info, warning, error | Estado de la respuesta. |
message | Texto variable | Mensaje personalizado que describe el resultado de la operación. |
data | Objeto o array | Contiene los datos devueltos en la petición, si corresponde. |
Manejo de Respuestas y Errores
- Las respuestas
200y201indican éxito, mientras que400,401,404y500deben manejarse adecuadamente para evitar interrupciones en la integración. - El campo
messageproporciona detalles adicionales sobre el estado de la solicitud. - El campo
datapuede contener información relevante o estar vacío ({}) si no se devuelve contenido adicional.
Asegúrate de validar siempre las respuestas para gestionar correctamente posibles errores o excepciones en la integración.