# API Clientes

# 1. Introducción

Bienvenido a la API de clientes de Mybooking. Este API permite extraer información de los clientes.

# 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 Customer

# Atributos

id number

Identificador del cliente.

object string

Tipo de objeto, "customer" representa un cliente

customer_type string

Tipo de cliente. Los valores posibles son:

individual Persona física
legal_entity Empresa
group_company Empresa del grupo
internal_department Departamento interno

full_name string

Nombre completo, incluyendo los apellidos si se trata de una persona física

name string

Nombre del cliente si es una persona física o bien el nombre de la empresa

surname string

Apellidos del cliente si es una persona física

document_id string

NIF, CIF o pasaporte

document_id_date string

Fecha de expedición del NIF, CIF o pasaporte. Formato AAAA-MM-DD

document_id_expiration_date string

Fecha de expiración del NIF, CIF o pasaporte. Formato AAAA-MM-DD

origin_country string

Nacionalidad

date_of_birth string

Fecha de nacimiento. Formato AAAA-MM-DD

rental_location_code string

Código de la sucursal si el cliente pertenece una sucursal. Sólo está informado para empresas que trabajan con múltiples sucursales.

sales_channel_code string

Código del canal de venta. Sólo está informado si la empresa gestionar múltiples canales de venta.

language string

Código ISO_639-1 del idioma del cliente.

email string

Correo electrónico del cliente.

phone_number_prefix string

Prefijo telefónico del cliente.

phone_number_prefix string

Prefijo número de teléfono principal del cliente.

phone_number string

Número número de teléfono principal del cliente.

mobile_phone_prefix string

Prefijo número de teléfono alternativo del cliente.

mobile_phone string

Número número de teléfono alternativo del cliente.

address_street string

Dirección del cliente. Calle

address_number string

Dirección del cliente. Número

address_complement string

Dirección del cliente. Complemento (escalera, piso, puerta)

address_city string

Dirección del cliente. Población o ciudad

address_state string

Dirección del cliente. Estado o provincia

address_country string

Dirección del cliente. País

address_zip string

Código postal

mobile_phone string

Número número de teléfono alternativo del cliente.

creation_date string

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

last_update string

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

  {
    "id": 202,
    "object": "customer",
    "customer_type": "individual",
    "full_name": "Brad Stark",
    "name": "Brad",
    "surname": "Stark",
    "document_id": "55555555R",
    "document_id_date": "2019-02-16",
    "document_id_expiration_date": null,
    "origin_country": "",
    "date_of_birth": "1990-02-09",
    "rental_location_code": "MAHON",
    "sales_channel_code": null,
    "language": "es",
    "email": "info@mybooking.es",
    "phone_number_prefix": "34",
    "phone_number": "666101010",
    "mobile_phone_prefix": "34",
    "mobile_phone": "",
    "address_street": "Sardenya",
    "address_number": "300",
    "address_complement": "1-1",
    "address_city": "Barcelona",
    "address_state": "Barcelona",
    "address_country": "",
    "address_zip": "08025",
    "creation_date": "2023-06-20T16:42:29.000+00:00",
    "last_update": "2023-06-20T16:42:29.000+00:00"
  }

# 3. API

# 3.1 Obtener clientes

GET /api/v1/integration/customers

Obtiene los clicnetes.

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
sales_channel_id	Identificador canal de venta	Filtra por canal de venta	Opcional
rental_location_code	Identificador de la sucursal	Filtra por sucursales	Opcional
last_update	Última actualización	Filtra los creados/actualizados a partir de fecha	Opcional

# Respuesta de la petición

  {
    "data": [
      {
        "id": 202,
        "object": "customer",
        "customer_type": "individual",
        "full_name": "Brad Stark",
        "name": "Brad",
        "surname": "Stark",
        "document_id": "55555555R",
        "document_id_date": "2019-02-16",
        "document_id_expiration_date": null,
        "origin_country": "",
        "date_of_birth": "1990-02-09",
        "rental_location_code": "MAHON",
        "sales_channel_code": null,
        "language": "es",
        "email": "info@mybooking.es",
        "phone_number_prefix": "34",
        "phone_number": "666101010",
        "mobile_phone_prefix": "34",
        "mobile_phone": "",
        "address_street": "Sardenya",
        "address_number": "300",
        "address_complement": "1-1",
        "address_city": "Barcelona",
        "address_state": "Barcelona",
        "address_country": "",
        "address_zip": "08025",
        "creation_date": "2023-06-20T16:42:29.000+00:00",
        "last_update": "2023-06-20T16:42:29.000+00:00"
      }
    ],
    "total": 1
  }