Una API con diseño RESTful implementa diversos verbos según la acción que se deba realizar, por ejemplo para obtener información se usa GET, para crear datos se usa POST, para modificar datos se utiliza PUT y por último para eliminar datos se utiliza DELETE.
Los parámetros que se puedan pasar a la API tienen 3 posibles ubicaciones:
- En el PATH del recurso consumido: Se deben incluir todos de forma obligatoria, salvo que se indique lo contrario. Un tipo de parámetro que siempre deberá ir en el path es el identificador de la empresa (TenantId).
- En la URL del recurso consumido: Estos parámetros permiten modificar el comportamiento de la consulta. Por ejemplo poder filtrar la información a obtener. Estos parámetros siempre serán opcionales, salvo que se indique lo contrario.
- En el cuerpo de la solicitud POST o PUT: Envío de datos para creación o modificación de la información de los recursos, en este último caso debe venir toda la información incluida la que no sería modificada.
A menos que se especifique lo contrario, todos los cuerpos de las llamadas a la API deben ser JSON con la cabecera:
Content-Type: application/json
Y de forma similar, la aplicación, a menos que se indique o soliciten los datos en un formato diferente, debe aceptar los datos en formato JSON con la cabecera:
Accept: application/json