Esta sección detalla los códigos de respuesta HTTP que indican una solicitud exitosa al interactuar con nuestra API. Entender estos códigos facilitará la implementación correcta de nuestros servicios en su aplicación y ayudará a manejar las respuestas de manera efectiva.
200 OK
Indica que la solicitud ha sido recibida, entendida y procesada correctamente. Este es el código de respuesta estándar para operaciones exitosas. Dependiendo del método HTTP utilizado, el cuerpo de la respuesta puede contener el recurso solicitado, el resultado de una operación o un mensaje de éxito.
201 Created
Se utiliza para confirmar que un recurso ha sido creado exitosamente como resultado de la solicitud. Este código se acompaña típicamente de un cuerpo de respuesta que incluye el recurso creado o un enlace al mismo. Es común en solicitudes POST que resultan en la creación de un nuevo recurso.
202 Accepted
Este código indica que la solicitud ha sido aceptada para procesamiento, pero el procesamiento aún no se ha completado. Es útil para operaciones que requieren tiempo para completarse, informando al cliente que la solicitud ha sido encolada.
204 No Content
La solicitud se ha completado con éxito, pero no hay contenido para enviar en el cuerpo de la respuesta. Este código es común en solicitudes DELETE o cuando una solicitud PUT o POST se procesa correctamente sin necesidad de enviar información adicional en el cuerpo de la respuesta.
Uso de Códigos de Respuesta
Es importante manejar adecuadamente estos códigos en su aplicación para asegurar una integración efectiva con nuestros servicios. Por ejemplo, al recibir un código 201, su aplicación debería ser capaz de acceder al recurso creado a través del enlace proporcionado en la respuesta. Asimismo, un código 202 podría requerir que su aplicación implemente una lógica verificación de estado para determinar cuando el procesamiento ha sido completado.
Cada código de respuesta viene acompañado de un cuerpo de respuesta opcional que puede proporcionar información adicional sobre el resultado de la solicitud. Le recomendamos consultar la especificación de cada recurso API para detalles sobre la estructura y el contenido esperado del cuerpo de respuesta.
Una buena practica es obtener el código de respuesta HTTP y si es del rango de 2XX, la solicitud puede entenderla como exitosa, asi implique consultar con posterioridad el estado de la misma para saber si se proceso exitosamente, tenga en cuenta de muchos de las API's tienen un procesamiento asincrono.
Detalle del código de respuesta
Cuando el endpoint API retorna un onjeto JSON, usted encontrará las siguientes propiedades:
- statusCode: Código de respuesta, el mismo obtenido en la solicitud HTTP
- statusMessage: Mensaje retornado al usuario, detallando la solicitud
- timestamp: Hora de solicitud en estandar ISO 8601
- responseTime: Milisegundos que tomó en procesar la solicitud
{
"payLoad": {
},
"statusCode": 200,
"statusMessage": "Service is up and running.",
"timestamp": "2024-03-10T12:00:00Z",
"responseTime": "150"
}