# API inventario
# 1. Introducción
Bienvenido a la API de inventario de Mybooking. Este API permite extraer información de la flota para poder procesarlas y crear dashboards.
# 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. API
# 2.1 Flota de vehículos o recursos
GET /api/booking-items
Obtiene la flota de vehículos o recursos.
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
| Parámetro | Descripción | Detalle | |
|---|---|---|---|
| page | Núm. de página | Número de la página solicitada. Valor 0 x defecto | Opcional |
| page_size | Núm. de registros por página | Permite paginar para obtener todos los contratos. Valor 10 x defecto | Opcional |
| rental_storage_id | Identificador grupo de sucursales | Filtra por el grupo de sucursales | Opcional |
# 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
Devuelve un JSON con los siguientes atributos
| Atributo | Descripción | Detalle |
|---|---|---|
| data | Vehículos o recursos | array[Object] |
| reference | Identificador | |
| category_code | Código de la categoría o grupo | |
| category_name | Nombre de la categoría o grupo | |
| item_description | Descripción - Marca/Modelo - Matrícula - Bastidor | |
| item_name | Nombre | |
| stock_brand | Marca (sin uso) | |
| stock_model | Marca y modelo | |
| stock_plate | Matrícula | |
| stock_reference | Alias (determinados tipos de negocio) | |
| virtual_item | Virtual (no representa un recurso/vehículo físico) | |
| description | Descripción (determinados tipos de negocio) | |
| usage_units | Km realizados | |
| own_property | Propiedad de la empresa (true/false) | |
| assignable | Se tiene en cuenta en la disponibilidad (no asignable no lo contabiliza como disponible) | |
| name | Nombre (determinados tipos de negocio) | |
| active | Activo (no activos representan vendidos o dados de baja) | |
| usage_available_fuel | Combustible actual (en fracciones de octavos) | |
| fuel | Tipo de combustible (none/petrol/diesel/electric/hybrid) | |
| registrable_registration_date | Fecha de matriculación AAAA-MM-DD | |
| purchasable_adquisition_date | Fecha de adquisición AAAA-MM-DD | |
| purchasable_sold_release_date | Fecha de baja o venta | |
| characteristic_1 | Combustible* (en desuso) | |
| characteristic_2 | Tipo de cambio | |
| characteristic_3 | Número de bastidor | |
| characteristic_4 | Color | |
| status | Estado (free/busy/maintenance/repair/preparation) | |
| purchasable_acquisition_mode | Forma de adquisicón (purchase/renting/rented/supplier/virtual) | |
| category_type | Tipo de categoría (category_of_resources/resource) | |
| category_family_name | Nombre de la familia | |
| currently_blocked | Está bloqueado actualmente | |
| blocked_date_end | Fecha de fin del bloqueo | |
| blocked_time_end | Hora de fin del bloqueo | |
| blocked_date_start | Fecha de inicio del bloqueo | |
| blocked_time_start | Hora de inicio del bloqueo | |
| blocked_id | Identificador del bloqueo actual | |
| booking_id | Identificador de la reserva actual | |
| delivery_date | Fecha de devolución de la reserva actual | |
| delivery_time | Hora de devolución de la reserva actual | |
| delivery_place | Lugar de devolución de la reserva actual | |
| rental_storage_id | Código del grupo de sucursales que gestiona el vehículo o recurso | |
| rental_storage_name | Nombre del grupo de sucursales que gestiona el vehículo o recurso | |
| owner_rental_storage_id | Código del grupo de sucursales propietario del vehículo o recurso | |
| owner_rental_storage_name | Nombre del grupo de sucursales propietario del vehículo o recurso | |
| rental_location_code | Código de la sucursal dónde está el vehículo o recurso | |
| rental_location_name | Nombre de la sucursal dónde está el vehículo o recurso | |
| physical_location_building | Ubicación física - Edificio | |
| physical_location_floor | Ubicación física - Planta | |
| physical_location_area | Ubicación física - Zona | |
| physical_location_slot | Ubicación física - Punto | |
| next_inspection_date | Fecha prevista próxima revisión | |
| next_inspection_time | Hora prevista próxima revisión | |
| next_inspection_units | Km previstos próxima revisión | |
| scheduled_inspection_date | Fecha planificada próxima revisión | |
| next_official_inspection_date | Fecha prevista próxima revisión oficial - ITV | |
| next_official_inspection_time | Hora prevista próxima revisión oficial - ITV | |
| next_official_inspection_expiration_date | Fecha caducidad revisión oficial - ITV | |
| current_insurance_start | Fecha inicio seguro | |
| current_insurance_end | Fecha fin seguro | |
| current_insurance_company | Nombre compañía aseguradora | |
| total | [Number] | Número total de registros |
{
"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
}