Qué son los tipos de solicitud de los métodos

Qué son los tipos de solicitud de los métodos

Resumen

Los métodos de APIs requieren la definición de un tipo de solicitud.

Sugerimos que respete los estádares REST/json al crear sus métodos, en base a las siguientes definiciones.



Tipos de petición o solicitud

Los métodos más utilizados en las solicitudes de APIs son los siguientes:

Tipo de solicitud
Descripción
GET


El método GET se utiliza para consultar u obtener datos del origen.

POST


El método POST se utiliza normalmente para para enviar un recurso o entidad al origen, es decir, para crear un nuevo registro.
A pesar de ello, pueden existir métodos POST que no realicen cambios en el origen sino que se utilicen para obtener datos.

PUT


El método PUT se utiliza para realizar el cambio de la totalidad de una entidad en el origen.

PATCH


El método PATCH se utiliza para aplicar modificaciones parciales en una entidad en el origen.

DELETE


El método DELETE se utiliza para borrar o eliminar una entidad o recurso en el origen.



Si bien esa es la definición del estándar, su API puede no ajusarse a estas especificaciones según sus requerimientos.

Recuede que la selección del tipo de solicitud en el método de la API es independiente de la solicitud que se enviará al origen. La solicitud que se envía al origen se define al crear el Origen de datos.

Es decir, ustede puede configurar una solicitud POST a su origen para obtener datos, mientras que puede exponer esos datos en un método GET. Esto le permite estandarizar los tipos de solicitud en base al estándar sin necesidad de realizar modificaciones en su origen de datos.

Únicamente las solicitudes GET pueden previsualizarse y probarse en el portal del desarrollador. El resto de los tipos de solicitud no se previsualizan en el portal para evitar ejecuciones indeseadas.