¿Cómo te podemos ayudar?

¿Cómo utilizar el método PATCH y PUT en Humand API?

  • Actualización

Para una correcta integración de sus sistemas externos con Humand, a través de nuestra API, es clave entender cómo utilizarla correctamente. Esto garantiza que todo funcione sin problemas.

¿Qué es el método PATCH? ¿Para qué sirve? 

El método PATCH es una solicitud HTTP que se utiliza para actualizar parcialmente las propiedades de un objeto. Es decir, el método PATCH sirve para poder actualizar las propiedades deseadas de un objeto particular:

  • Las propiedades del objeto user son: password - relationships - fields - employeeInternalId - email - firstName - lastName - nickname - phoneNumber - hiringDate - birthdate.
  • Con el método PATCH cada propiedad es modificada por completo. 
  • Ejemplo: Podemos modificar la información de la propiedad firstName del objeto Usuario

¿Y qué es el método PUT? ¿Para qué sirve? 

El método PUT también es una solicitud HTTP pero que se utiliza para reemplazar completamente un objeto. Es decir, el método PUT reemplaza todo el objeto:

  • Los objetos que podemos modificar via API son: user - file - article - segmentation - products - acknoledgments
  • Con el método PUT cada objeto es modificado por completo.
  • Ejemplo: segmentation es un objeto en su totalidad. Es por este motivo que la modificación de la segmentación no es parcial aunque utilicemos el método PATCH. Esto implica que cualquier grupo de segmentación que no enviamos por integración se borra de la información del usuario. Es decir, se deben enviar todas las segmentaciones desde la API, usando PUT o PATCH. 

Consideraciones finales:

  •  Actualmente, se deben enviar desde la API todas las segmentaciones. Es decir, se deben enviar todas las segmentaciones desde la API, usando PUT o PATCH. Ejemplo: Si hay 4 grupos de segmentación que se envían desde API, manualmente desde Humand Admin se crea un 5to grupo de segmentación y se suman usuarios, este 5to grupo y sus usuarios también comenzar a ser enviados desde la API,  porque como dijimos: segmentation es un objeto en su totalidad. 
  • Cada propiedad puede ser actualizada de manera individual utilizando PATCH, por lo que cualquiera de los campos password - relationships - fields - employeeInternalId - email - firstName - lastName - nickname - phoneNumber - hiringDate - birthdate pueden ser actualizados únicamente usando PATCH,
  • Mientras que los objetos, user - file - article - segmentation - products - acknoledgments, deben ser actualizados utilizando PUT.

 

 

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

¿Tiene más preguntas? Enviar una solicitud