API Organización

1. Introducción

Bienvenido a la API de organización de Mybooking. Este API permite extraer información de la estructura organizativa de la empresa y los puntos de entrega y devolución.

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 RentalStorage

Representan los grupos de sucursales o concesionarios. Cada grupo de sucursales comparte su flota o inventario entre las sucursales del grupo.

Atributos

---

id number

Identificador del grupo de sucursales.

---

object string

Tipo de objeto, "rental_storage" representa un grupo de sucursales

---

name string

Nombre del grupo de sucursales

---

classifier_id number

Clasificador de grupos de sucursales. Se usa para segmentarlas en marca u otros criterios

---

classifier_name number

Nombre del clasificador

---

timezone string

Zona horaria

---

address_street_address string

Dirección - Calle, número y complemento

---

address_city string

Dirección - Nombre de la población

---

address_state string

Dirección - Provincia o estado

---

address_zip string

Dirección - Código postal

---

address_country_code string

Dirección - País

---

address_lat number

Dirección - Latitud de la ubicación

---

address_lng string

Dirección - Longitud de la ubicación

---

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

  {
    "id": 3,
    "object": "rental_storage",
    "name": "MAHON",
    "classifier_id": 36,
    "classifier_name": "Marca",
    "timezone": "Europe/Madrid",
    "address_street_address": null,
    "address_city": null,
    "address_state": null,
    "address_zip": null,
    "address_country_code": null,
    "address_lat": null,
    "address_lng": null,
    "creation_date": "2023-07-05T14:47:29.000+00:00",
    "last_update": "2023-07-05T14:47:29.000+00:00"
  }

Objecto RentalLocation

Representan las sucursales. Son entidades de gestión que pueden representar diferentes empresas y que pueden llegar a tener su propia facturación y usuarios.

Atributos

---

code string

Identificador de la sucursal sucursales.

---

object string

Tipo de objeto, "rental_location" representa una sucursal

---

name string

Nombre de la sucursal

---

classifier_id number

Clasificador de grupos de sucursales. Se usa para segmentarlas en marca u otros criterios

---

classifier_name number

Nombre del clasificador

---

place_type string

Tipo de ubicación. Los valores posibles son:

• location Oficina o tienda
• airport Aeropuerto
• harbor Puerto
• bus_station Estación de autobús
• train_station Estación de tren
• accommodation Alojamiento
• hotel Hotel

---

timezone string

Zona horaria

---

currency string

Moneda

---

rental_storage_id number

Identificador del grupo de sucursales

---

company_name string

Nombre fiscal

---

document_id string

NIF/CIF

---

phone_number string

Teléfono

---

whatsapp_number string

WhatsApp

---

emergency_number string

Teléfono de emergencias

---

commercial_register string

Información del registro

---

address_street_address string

Dirección - Calle, número y complemento

---

address_city string

Dirección - Nombre de la población

---

address_state string

Dirección - Provincia o estado

---

address_zip string

Dirección - Código postal

---

address_country_code string

Dirección - País

---

address_lat number

Dirección - Latitud de la ubicación

---

address_lng string

Dirección - Longitud de la ubicación

---

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": "MAHON",
    "object": "rental_location",
    "name": "OFICINA MAHÓN",
    "classifier_id": 36,
    "classifier_name": "Marca",
    "place_type": "location",
    "timezone": "Europe/Madrid",
    "currency": "EUR",
    "rental_storage_id": 3,
    "company_name": "MAHON SL",
    "document_id": "B1122334455",
    "phone_number": "",
    "whatsapp_number": "",
    "email": "",
    "emergency_number": null,
    "commercial_register": "",
    "address_street_address": "",
    "address_city": "",
    "address_state": "",
    "address_zip": "",
    "address_country_code": "",
    "address_lat": 0,
    "address_lng": 0,
    "creation_date": "2023-07-05T14:47:29.000+00:00",
    "last_update": "2023-07-05T14:47:29.000+00:00"
  }

Objecto PickupPlace

Representan los puntos de entrega y devolución. No todos los tipos de negocios trabajan con lugares de entrega y devolución. Una sucursal puede tener múltiples puntos de entrega y devolución.

Atributos

---

id number

Identificador del punto de entrega/devolución.

---

object string

Tipo de objeto, "pickup_return_place" representa una sucursal

---

name string

Nombre de la sucursal

---

classifier_id number

Clasificador de grupos de sucursales. Se usa para segmentarlas en marca u otros criterios

---

classifier_name number

Nombre del clasificador

---

place_type string

Tipo de ubicación. Los valores posibles son:

• location Oficina o tienda
• airport Aeropuerto
• harbor Puerto
• bus_station Estación de autobús
• train_station Estación de tren
• accommodation Alojamiento
• hotel Hotel

---

is_pickup boolean

Indica que se trata de un lugar de entrega

---

is_return boolean

Indica que se trata de un lugar de entrega

---

web_public boolean

Indica que está visible en la página web

---

price string

Suplemento de entrega/devolución. Formato NN.NN

---

rental_location_code string

Identificador de la sucursal a la que pertence el punto de entrega

---

iata string

Código IATA en el caso que el punto de entrega corresponda a un aeropuerto

---

address_street_address string

Dirección - Calle, número y complemento

---

address_city string

Dirección - Nombre de la población

---

address_state string

Dirección - Provincia o estado

---

address_zip string

Dirección - Código postal

---

address_country_code string

Dirección - País

---

address_lat number

Dirección - Latitud de la ubicación

---

address_lng string

Dirección - Longitud de la ubicación

---

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

  {
    "id": 2,
    "object": "pickup_return_place",
    "name": "Aeropuerto de Mahón",
    "classifier_id": 36,
    "classifier_name": "Marca",
    "place_type": "airport",
    "is_pickup": true,
    "is_return": true,
    "web_public": true,
    "price": "0.0",
    "rental_location_code": "MAHON",
    "iata": "MAH",
    "address_street_address": "",
    "address_city": "",
    "address_state": "",
    "address_zip": "",
    "address_country_code": "",
    "address_lat": null,
    "address_lng": null,
    "creation_date": "2023-07-05T14:47:29.000+00:00",
    "last_update": "2023-07-05T14:47:29.000+00:00"
  }

3. API

3.1 Obtener grupos de sucursales

GET /api/v1/integration/rental-storages

Obtiene los grupos de sucursales.

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

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. Valor 100 x defecto	Opcional
last_update	Última actualización	Filtra los creados/actualizados a partir de fecha	Opcional

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/v1/integration/rental-storages?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/rental-storages?page=0&page_size=20&last_update=2023-05-01'

Respuesta de la petición

  {
    "data": [
      {
        "id": 3,
        "object": "rental_storage",
        "name": "MAHON",
        "classifier_id": 36,
        "classifier_name": "Marca",
        "timezone": "Europe/Madrid",
        "address_street_address": null,
        "address_city": null,
        "address_state": null,
        "address_zip": null,
        "address_country_code": null,
        "address_lat": null,
        "address_lng": null,
        "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 las sucursales

GET /api/v1/integration/rental-locations

Obtiene las sucursales.

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

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. Valor 100 x defecto	Opcional
last_update	Última actualización	Filtra los creados/actualizados a partir de fecha	Opcional

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/v1/integration/rental-locations?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/rental-locations?page=0&page_size=20&last_update=2023-05-01'

Respuesta de la petición

  {
    "data": [
      {
        "code": "MAHON",
        "object": "rental_location",
        "name": "OFICINA MAHÓN",
        "classifier_id": 36,
        "classifier_name": "Marca",
        "place_type": "location",
        "timezone": "Europe/Madrid",
        "currency": "EUR",
        "rental_storage_id": 3,
        "company_name": "MAHON SL",
        "document_id": "B1122334455",
        "phone_number": "",
        "whatsapp_number": "",
        "email": "",
        "emergency_number": null,
        "commercial_register": "",
        "address_street_address": "",
        "address_city": "",
        "address_state": "",
        "address_zip": "",
        "address_country_code": "",
        "address_lat": 0,
        "address_lng": 0,
        "creation_date": "2023-07-05T14:47:29.000+00:00",
        "last_update": "2023-07-05T14:47:29.000+00:00"
      }
    ],
    "total": 1
  }

3.3 Obtener los puntos de entrega y devolución

GET /api/v1/integration/pickup-places

Obtiene los puntos de entrega y devolución.

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

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. Valor 100 x defecto	Opcional
last_update	Última actualización	Filtra los creados/actualizados a partir de fecha	Opcional

# Script para obtener la firma en Ruby
require 'openssl'
SECRET_KEY='MI-SECRET-KEY'
url='/api/v1/integration/pickup-places?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/pickup-places?page=0&page_size=20&last_update=2023-05-01'

Respuesta de la petición

  {
    "data": [
      {
        "id": 2,
        "object": "pickup_return_place",
        "name": "Aeropuerto de Mahón",
        "classifier_id": 36,
        "classifier_name": "Marca",
        "place_type": "airport",
        "is_pickup": true,
        "is_return": true,
        "web_public": true,
        "price": "0.0",
        "rental_location_code": "MAHON",
        "iata": "MAH",
        "address_street_address": "",
        "address_city": "",
        "address_state": "",
        "address_zip": "",
        "address_country_code": "",
        "address_lat": null,
        "address_lng": null,
        "creation_date": "2023-07-05T14:47:29.000+00:00",
        "last_update": "2023-07-05T14:47:29.000+00:00"
      }
    ],
    "total": 1
  }