# API Inventario

# 1. Introducción

Bienvenido a la API de inventario de Mybooking. Este API permite extraer información del inventario.

# 1.1 Credenciales

Consulta el funcionamiento de las credenciales con API Key y Secret Key para ver cómo funciona la autenticación en el acceso a las APIs.

# 1.2 URL base

Cada una de las cuentas de Mybooking son accesible a través de un subdominio único id de cliente. Si el id de cliente es rentpepe la URL base para realizar las peticiones será:

https://rentpepe.mybooking.es

# 2. Modelo de datos

# Objecto BookingCategory

Representan las categorías comerciales que los clientes contratan.

# Atributos

code string

Código de la categoría.

object string

Tipo de objeto, "booking_category" representa una categoría

name string

Nombre de la categoría

family_id number

Clasificador de familias. Se usa para segmentarlas las categorías

family_name number

Nombre la familia

active boolean

Si está activa la categoría en la plataforma

web_public boolean

Si la categoría puede reservarse en la web

creation_date string

Timestamp creación. Formato AAAA-MM-DD HH:mm:SS.LLL+HH:MM

last_update string

Timestamp última actualización. Formato AAAA-MM-DD HH:mm:SS.LLL+HH:MM

  {
    "code": "A",
    "object": "booking_category",
    "name": "City Car",
    "family_id": null,
    "family_name": null,
    "active": true,
    "web_public": true,
    "creation_date": "2023-07-05T14:47:29.000+00:00",
    "last_update": "2023-07-05T14:47:29.000+00:00"
  }

# Objecto BookingItem

Representan el inventario o la flota

# Atributos

reference string

Identificador del recurso o vehículo.

object string

Tipo de objeto, "booking_item" representa un recurso o vehículo

name string

Nombre del recurso o vehículo

category_code string

Código de la categoría

rental_storage_id number

Identificador del grupo de sucursales que gestiona actualmente el recurso o vehículo

owner_rental_storage_id number

Identificador del grupo de sucursales al que pertenece el recurso o vehículo

rental_location_code string

Código de la sucursal en la que se encuentra actualmente el recurso o vehículo

stock_brand string

Marca.

stock_model string

Modelo

stock_plate string

Matrícula

stock_reference string

Alias

stock_color string

Color.

characteristic_1 string

Campo personalizado 1. Depende del tipo de negocio

Tipos de negocio:

• Alquiler de vehículos: Tipo de combustible (usar el atributo fuel en lugar de este campo)

characteristic_2 string

Campo personalizado 2. Depende del tipo de negocio

Tipos de negocio:

• Alquiler de vehículos: Transmisión

characteristic_3 string

Campo personalizado 3. Depende del tipo de negocio

Tipos de negocio:

• Alquiler de vehículos: Número de bastidor

characteristic_4 string

Campo personalizado 4. Depende del tipo de negocio

Tipos de negocio:

• Alquiler de vehículos: Color (usar el atributo stock_color en su lugar)

purchasable_acquisition_mode string

Forma de adquisición. Los valores posibles son:

• purchase : Compra
• renting : Renting
• rented : Alquilado
• supplier : Pertenece a proveedor
• virtual : Recurso virtual - No hace referencia a un recurso específico

purchasable_adquisition_date string

Fecha de alta/adquisición. Formato YYYY-MM-DD

purchasable_sold_release_date string

Fecha de baja/venta. Formato YYYY-MM-DD

purchasable_purchase_price string

Coste de adquisición. Formato NN.NN

purchasable_purchase_units number

Unidades de uso en el momento de adquisición. Km, Horas de motor ...

purchasable_sale_price string

Precio de venta. Formato NN.NN

purchasable_renting_monthly_fee string

Coste mensual. Formato NN.NN

purchasable_insurance_monthly_fee string

Coste mensual del seguro (si se paga a parte). Formato NN.NN

usage_units number

Unidades de uso en el momento actual. Km, horas de motor, ...

usage_available_fuel string

Combustible disponible actual. Formato fracción del tamaño del depósito o bien en unidades.

fuel string

Tipo de combustible. Los valores posibles son:

• none : Ninguno
• petrol : Gasolina
• diesel : Diesel
• electric : Eléctrico
• hybrid : Híbrido

tank_capacity string

Tamaño del depósito. Formato NN.NN

active boolean

Si está activo en la plataforma

assignable boolean

Si se puede asignar directamente al asignar una reserva. Este atributo tendrá el valor false cuando se trate de un recurso que queremos que aparezca en el planning pero que el sistema no lo tenga en cuenta en la disponibilidad.

creation_date string

Timestamp creación. Formato AAAA-MM-DD HH:mm:SS.LLL+HH:MM

last_update string

Timestamp última actualización. Formato AAAA-MM-DD HH:mm:SS.LLL+HH:MM

  {
      "reference": "1",
      "object": "booking_item",
      "name": null,
      "category_code": "D1",
      "rental_storage_id": 3,
      "owner_rental_storage_id": 3,
      "rental_location_code": "TEAMS-MOTOR",
      "stock_brand": null,
      "stock_model": "* C-HR",
      "stock_plate": "9257LGD",
      "stock_reference": null,
      "stock_color": null,
      "characteristic_1": "GASOLINA",
      "characteristic_2": "AUTOMATICA",
      "characteristic_3": "nmtk33bxx0r020232",
      "characteristic_4": "ROJO",
      "purchasable_acquisition_mode": "renting",
      "purchasable_adquisition_date": "2021-01-18",
      "purchasable_sold_release_date": "2021-05-25",
      "purchasable_purchase_price": "0.0",
      "purchasable_purchase_units": 0,
      "purchasable_sale_price": "0.0",
      "purchasable_renting_monthly_fee": "271.19",
      "purchasable_insurance_monthly_fee": "0.0",
      "purchasable_renting_duration": 12,
      "usage_units": 6900,
      "usage_available_fuel": "1/8",
      "fuel": "hybrid",
      "tank_capacity": "43.0",
      "active": false,
      "assignable": true,
      "creation_date": "2023-07-05T14:47:33.000+00:00",
      "last_update": "2023-07-05T14:47:33.000+00:00"
  }

# 3. API

# 3.1 Obtener categorías

El volumen de datos que puede llegar a devolver este end-point puede ser demasiado grande para obtenerlos en una única petición. Por esto, se ha implementado con un sistema de paginación que permite ir obtiendo los datos en grupos más reducidos. De forma predeterminada obtiene 100 elementos y retorna el número total de forma que permite implementar un sistema de navegación.

# Petición

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/v1/integration/booking-categories?page=0&page_size=20&last_update=2023-05-01'
signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), SECRET_KEY, url)

# Comando CURL usando el API y la firma para realizar la petición
curl -H "Authorization: {API-KEY}:{signature}" -H "Content-Type: application/json" -X GET 'https://micuenta.mybooking.es/api/v1/integration/booking-categories?page=0&page_size=20&last_update=2023-05-01'

# Respuesta de la petición

  {
    "data": [
      {
        "code": "A",
        "object": "booking_category",
        "name": "City Car",
        "family_id": null,
        "family_name": null,
        "active": true,
        "web_public": true,
        "creation_date": "2023-07-05T14:47:29.000+00:00",
        "last_update": "2023-07-05T14:47:29.000+00:00"
      }
    ],
    "total": 1
  }

# 3.2 Obtener flota

El volumen de datos que puede llegar a devolver este end-point puede ser demasiado grande para obtenerlos en una única petición. Por esto, se ha implementado con un sistema de paginación que permite ir obtiendo los datos en grupos más reducidos. De forma predeterminada obtiene 100 elementos y retorna el número total de forma que permite implementar un sistema de navegación.

# Petición

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/v1/integration/booking-categories?page=0&page_size=20&last_update=2023-05-01'
signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), SECRET_KEY, url)

# Comando CURL usando el API y la firma para realizar la petición
curl -H "Authorization: {API-KEY}:{signature}" -H "Content-Type: application/json" -X GET 'https://micuenta.mybooking.es/api/v1/integration/booking-categories?page=0&page_size=20&last_update=2023-05-01'

# Respuesta de la petición

  {
    "data": [
      {
        "reference": "1",
        "object": "booking_item",
        "name": null,
        "category_code": "D1",
        "rental_storage_id": 3,
        "owner_rental_storage_id": 3,
        "rental_location_code": "TEAMS-MOTOR",
        "stock_brand": null,
        "stock_model": "* C-HR",
        "stock_plate": "9257LGD",
        "stock_reference": null,
        "stock_color": null,
        "characteristic_1": "GASOLINA",
        "characteristic_2": "AUTOMATICA",
        "characteristic_3": "nmtk33bxx0r020232",
        "characteristic_4": "ROJO",
        "purchasable_acquisition_mode": "renting",
        "purchasable_adquisition_date": "2021-01-18",
        "purchasable_sold_release_date": "2021-05-25",
        "purchasable_purchase_price": "0.0",
        "purchasable_purchase_units": 0,
        "purchasable_sale_price": "0.0",
        "purchasable_renting_monthly_fee": "271.19",
        "purchasable_insurance_monthly_fee": "0.0",
        "purchasable_renting_duration": 12,
        "usage_units": 6900,
        "usage_available_fuel": "1/8",
        "fuel": "hybrid",
        "tank_capacity": "43.0",
        "active": false,
        "assignable": true,
        "creation_date": "2023-07-05T14:47:33.000+00:00",
        "last_update": "2023-07-05T14:47:33.000+00:00"
      }
    ],
    "total": 1
  }

# 3.3 Obtener flota (versión extendida)

El volumen de datos que puede llegar a devolver este end-point puede ser demasiado grande para obtenerlos en una única petición. Por esto, se ha implementado con un sistema de paginación que permite ir obtiendo los datos en grupos más reducidos. De forma predeterminada obtiene 10 elementos y retorna el número total de forma que permite implementar un sistema de navegación.

# Petición

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/booking-items?page=0&page_size=10'
signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), SECRET_KEY, url)

# Comando CURL usando el API y la firma para realizar la petición
curl -H "Authorization: {API-KEY}:{signature}" -H "Content-Type: application/json" -X GET '/api/booking-items?page=0&page_size=10'

# Respuesta de la petición

  {
    "data": [
      {
        "reference": "6",
        "category_code": "A",
        "category_name": "City Car",
        "item_description": "TOYOTA AYGO - 0001FFF - 320932093203",
        "item_name": null,
        "stock_brand": null,
        "stock_model": "TOYOTA AYGO",
        "stock_plate": "0001FFF",
        "stock_reference": null,
        "virtual_item": false,
        "description": null,
        "usage_units": 1900,
        "own_property": true,
        "assignable": true,
        "name": "MAHON",
        "active": true,
        "usage_available_fuel": "8/8",
        "fuel": "petrol",
        "registrable_registration_date": "2021-02-10",
        "purchasable_adquisition_date": "2022-07-21",
        "purchasable_sold_release_date": null,
        "characteristic_1": "GASOLINA",
        "characteristic_2": "MANUAL",
        "characteristic_3": "320932093203",
        "characteristic_4": "BLANCO",
        "status": "free",
        "purchasable_acquisition_mode": "purchase",
        "category_type": "category_of_resources",
        "category_family_name": null,
        "currently_blocked": 0,
        "blocked_date_end": null,
        "blocked_time_end": null,
        "blocked_date_start": null,
        "blocked_time_start": null,
        "blocked_id": null,
        "booking_id": null,
        "delivery_date": null,
        "delivery_time": null,
        "delivery_place": null,
        "rental_storage_id": 3,
        "rental_storage_name": "MAHON",
        "owner_rental_storage_id": 3,
        "owner_rental_storage_name": "MAHON",
        "rental_location_code": "MAHON",
        "rental_location_name": "OFICINA MAHÓN",
        "physical_location_building": null,
        "physical_location_floor": null,
        "physical_location_area": null,
        "physical_location_slot": null,
        "inspection_item_id": 82,
        "official_inspection_item_id": 79,
        "insurance_item_id": 76,
        "next_inspection_date": null,
        "next_inspection_time": null,
        "next_inspection_units": null,
        "scheduled_inspection_date": null,
        "next_official_inspection_date": "2022-10-14",
        "next_official_inspection_time": "10:00",
        "next_official_inspection_expiration_date": null,
        "current_insurance_start": null,
        "current_insurance_end": null,
        "current_insurance_company": null,
        "current_insurance_policy_number": null
      }
    ],
    "total": 1
  }