5. Tipos de Parámetros

Si no estas familiarizado con las integraciónes mediante servicios Rest, es de vital importancia que leas esta sección. Un servicio Rest no es más que una URL que puede recibir parámetros desde distintas partes. A la llamada en si, más el conjunto de parámetros, se le llama Request, mientras que a la respuesta se le llama Response. El Request puede ser acompañado por distintos parámetros que a su vez pueden ser enviados en distintos lugares. La diferencia de cada lugar se corresponde principalmente a un principio de orden, pues, en teoría, un mismo parámetro podría ser enviado por cualquiera de los lugares disponibles. Estos "lugares" reciben los nombres de parámetros por Path, Query, Header y Body los cuales son descritos en detalle a continuación:

5.1. Path

Estos parámetros suelen pasar desapercibidos, son parte de la URL a la que se envia el request. Cuando se específica un parámetro por path, suele verse entre llaves, como por ejemplo {parametro}. Estos no son parámetros nombrados, es decir, se ingresa directamente el valor. Un ejemplo práctico, supongamos que queremos ver la información de un documento (por ahora, y para facilitar las cosas, omitiremos los demás tipos de parámetros que requiere este endpoint), para esto debemos enviar un request a la url https://api.febos.io/pruebas/documentos/{febosId}. Como se puede apreciar, se ve un parámetro por path en la descripción de la url, en este caso {febosId}. El parámetro febosId corresponde al identificador único de cada documento, supongamos que queremos obtener el documento cuyo febosId es: eaa362909975204aa43bd28-ba9e4503db58. En tal caso, la url final que consumiremos será https://api.febos.io/pruebas/documentos/eaa362909975204aa43bd28-ba9e4503db58, reemplazando de esta forma el placeholder febosId por el valor correspondiente a dicho parámetro.

5.2. Query

Este tipo de parámetros son fácilmente identificables por medio de la URL. Siempre se encontrarán después de un signo de pregunta "?". Cada parámetro es proporcionado por un nombre y un valor, mientras que un conjunto de parámetros puede ser separado por medio de un "&". Pogamos como ejemplo el caso anterior, intentaremos obtener la información de un documento, primero, viendo la descripción:

https://api.febos.io/pruebas/documentos/{febosId}?xmlFirmado&incrustar

En esta descripción, se nos pide ingresar 1 parámetro por Path (febosId), y 2 parámetros por Query (xmlFirmado incrustar). Los parámetros por query pueden recibir cualquier valor, dependiendo de lo que indique la documentación, siendo para este caso, que pueden soportar los valores "si" o "no". Supongamos que consumiremos dicha url con los siguientes valores:

febosId: eaa362909975204aa43bd28-ba9e4503db58

xmlFirmado: si

incrustar: no

Tendiendo dichos valores presentes que queremos enviar, la url final a consumir queda de la siguiente forma:

  https://api.febos.io/pruebas/documentos/eaa362909975204aa43bd28-ba9e4503db58?xmlFirmado=si&incrustar=no

5.3. Header

Las variables que son enviadas por Header generalmente no son visibles facilmente, no se ven en la URL, si no que son especificas del cliente que enviará la solicitud a la URL. En Febos hay un parámetro por header que es obligatorio, el cual es content-type cuyo valor debe ser application/json, ademas de los parámetros token y empresa que podrás encontrar en la documentación de los endpoints. Para enviar este tipo de parámetros te sugerimos buscar en la documentación de tu lenguaje de programación o ver los ejemplos que aparecen en los endpoints, te podrían servir de referencia.

5.4. Body

Al igual que los parámetros por Header, los parámetros por Body no se ven en la URL, este tipo de parámetros corresponden a textos más extensos que un simple nombre de variable y un valor. En Febos este tipo de parámetros se utiliza para enviar archivos JSON como parte del request, usados generalmente para enviar información para almacenar o modificar. Al igual que los parámetros por Header, te sugerimos buscar en la documentación de tu lenguaje de programación o ver los ejemplos que aca proporcionamos.

5.5 Verbos

Cuando se consume una URL para enviar un request, se debe acompañar de una "acción", o mejor dicho de un "verbo". El protocolo http nos proporciona un conjunto de verbos que podemos utilizar, y una misma URL puede recibir más de un verbo, teniendo un efecto distinto como resultado, a pesar de ser la misma url. Por regla general los verbos disponibles en Febos y su accion se describen a continuación:

Verbo	Acción
GET	Obtener información de un elemento o una lista de elementos
POST	Creación de un elemento nuevo, o la gatillación de una acción
PUT	Edición de un objeto o atributo de algún elemento
DELETE	Elimina el elemento especificado en la URL

5. Tipos de Parámetros

5.1. Path#

5.2. Query#

5.3. Header#

5.4. Body#

5.5 Verbos#

5.1. Path

5.2. Query

5.3. Header

5.4. Body

5.5 Verbos