Introducción:
En la API de Hotel Data Hub, encontraremos que se requieren varios valores de tipo numérico, los cuales identifican a un item u elemento en la base de datos de Fideltour. Podemos deducir, que si un item no existe en la base de datos, previamente habrá que crearlo para consultar el identificador.
En el artículo veremos como crear y consultar los diferentes items de forma externa a Hotel Data Hub. Los métodos que utilizaremos se pueden encontrar en el swagger. Veremos ejemplos con los campos indispensables para la correcta utilización de la API. En algunos items podemos encontrar campos adicionales donde introducir mas información, estos son opcionales.
Se entiende como item u elemento, cualquier dato o conjunto de datos que podamos utilizar en repetidas ocasiones durante la utilización de nuestro CRM, por ejemplo: un tipo de habitación, el nombre de una agencia, el nombre de una provincia, etc...
El endpoint base que utilizaremos para los items es: https://app.hoteldatahub.io/api/v1/xxx/
Añadiendo en el lugar de "xxx", el valor que nos indique la documentación de la API en cada caso.
Casos de uso:
La gestión de items es prácticamente indispensable para utilizar la API de Hotel Data Hub, si queremos hacer un buen uso de la plataforma y recoger la mayor información posible.
- Creación de nuevos items: los cuales quedarán guardados de forma constante en Fideltour, ayudando así a poder automatizar procesos para acceder a la información de los items.
- Consulta de información de los items: será necesario acceder a la información de los items cuando deseemos obtener el identificador de este y así poder añadirlo a nuestras peticiones. De esta manera se mantiene la integridad de la información dejando menos lugar a los errores en las peticiones.
Métodos disponibles:
- GET: Consulta de datos de un item.
- POST: Inserción de un nuevo item.
Ejemplos:
Actualmente los diferentes items de Fideltour y sus métodos, son los siguientes:
- agency - ver métodos de agency
- custom_tags - ver métodos de custom_tags
- room_type - ver métodos de room_type
- regime - ver métodos de regime
- province - ver métodos de province
- town - ver métodos de town
- zone - ver métodos de zone
A continuación mostraremos algunos ejemplos de creación y visualización de items en Fideltour.
Petición (POST):
En el siguiente ejemplo se muestra una solicitud para añadir una provincia en Hotel Data Hub.
En este caso el campo solicitado es "name", en otros será "code", adaptaremos la petición al método que estemos utilizando.PROTOCOLO: HTTP/1.1
METODO: POST
HOST/ENDPOINT: https://app.hoteldatahub.io/api/v1/provinces/
HEADERS:
Content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
BODY: se añade un ejemplo a continuación.
- {
- "name": "Islas baleares",
- }
Respuesta (POST):
- {
- "id": 12345,
- "name": "Islas Baleares"
- }
Petición (GET):
En el siguiente ejemplo se muestra una solicitud para consultar la información del tipo de habitación "junior-suite".
PROTOCOLO: HTTP/1.1
METODO: GET
HOST/ENDPOINT: https://app.hoteldatahub.io/api/v1/room-types/?code=junior-suite
HEADERS:
- Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
BODY: En este caso al ser un método de tipo GET no incluimos datos en el cuerpo de la petición, ya que se incluyen en la url.
Respuesta (GET):
Podemos comprobar que en el campo "id"(identificador), la petición nos ha devuelto un número.
Este número es el que debemos añadir en las futuras peticiones, cuando se quiera indicar que el tipo de habitación es "junior-suite".
- {
- "count": 1,
- "next": null,
- "previous": null,
- "results": [
- {
- "id": 2541,
- "code": "junior-suite"
- }
- ]
- }