API
Documentación

Creación de un transporte

Permite crear transporte en Driiveme

    Request    

Url (POST)

https://www.driiveme.es/api/transport/create?key=[YOUR-API-KEY]

Estructura del cuerpo (JSON)

type Enum Tipo de transporte (defecto=1)
1 - Transporte sencillo del punto A al punto B
2 - Entrega al cliente con conductor Profesional
3 - Recogida de vehículo
driverType Enum Tipo de conductor (defecto=2)
1 - Conductor particular (no profesional)
2 - Conductor profesional
3 - Camión
Solo si 'Transporte simple' ('type = 1')
idAdmin * Int ID Driiveme del administrador que crea el transporte
idEntity Int Identificador DriiveMe de una entidad de facturación
Ver entidad API
idTransportFirstStep Int Identificador mision Driiveme de un transporte anterior para enlazar 2 transportes (Entrega + Recogida)
idClient String ID Cliente del transporte
emailDriver Email Permitir a obligar a un condcutor a realizar el transporte
isProduction Bool Si el parámetro está presente con el valor 'true', el transporte se creará en producción
departure
departure.id *** Int ID Driiveme de la dirección
*** o (departure.id / departure.fullAddress)
Ver API
departure.fullAddress *** String Dirección precisa completa
ex: 10 boulevard des batignolles, 75017 Paris
*** o (departure.id / departure.fullAddress)
departure.type * Enum Tipo de establecimiento de dirección
1 - Agencia
2 - Concesionario
3 - Taller
4 - Tienda - Local
5 - Empresa
6 - Cliente particular
7 - Campa - Parking
* Obligatorio si se ingresa 'departure.fullAddress'
departure.name * String Nombre del establecimiento / persona
* Obligatorio si se ingresa 'departure.fullAddress'
departure.emails String Dirección de correo electrónico
Sólo si se rellena 'departure.fullAddress' / (si hay más de una separar por comas)
departure.phones String Teléfono(s) de dirección
Sólo si se rellena 'departure.fullAddress' / (si hay más de una separar por comas)
destination
destination.id *** Int ID Driiveme de la dirección
*** o (destination.id / destination.fullAddress)
Ver API
destination.fullAddress *** String Dirección completa
ex: 10 boulevard des batignolles, 75017 Paris
*** o (destination.id / destination.fullAddress)
destination.type * Enum Tipo de establecimiento de dirección
1 - Agencia
2 - Concesionario
3 - Taller
4 - Tienda - Local
5 - Empresa
6 - Cliente particular
7 - Campa - Parking
* Obligatorio si se ingresa 'dirección de destino.
destination.name * String Nombre del establecimiento / persona
* Obligatorio si se ingresa 'dirección de destino.
destination.emails String Dirección de correo electrónico
Sólo si destination.fullAddress' está rellenado / (si hay más de uno debe estar separado por comas)
destination.phones String Teléfono(s) de dirección
Sólo si destination.fullAddress' está rellenado / (si hay más de uno debe estar separado por comas)
vehicle
vehicle.id ** Int ID Driiveme de vehículo
** obligatorio si 'vehicle.category' es nulo
Ver API vehículo
vehicle.category ** Enum Categorie du véhicule à déplacer
1 - Turismo
2 - Berlina
3 - Deportivo
4 - Monovolumen
5 - SUV
6 - Furgoneta
7 - Pickup
8 - autocaravana
** obligatorio si 'vehicle.id' es nulo
vehicle.size ** Int Tamaño de la furgoneta
Sólo si la categoría Furgoneta 'vehicle.category = 6'
vehicle.model String Marca / modelo del vehículo
vehicle.nbSeats Int Número de asientos en el vehículo
5 asientos predeterminados y 3 para furgoneta
vehicle.registration String Matrícula del vehículo
vehicle.vin String Número de bastidor del vehículo
date
date.beginAvailability DateTime Fecha de inicio de disponibilidad a la salida
date.endAvailability DateTime Fecha de fin de disponibilidad a la salida
Calculado automáticamente si no se informa
date.beginDelivery DateTime Fecha mínima de entrega a la llegada
Calculado automáticamente si no se informa
date.endDelivery * DateTime Fecha máxima de entrega a la llegada
date.endOffer DateTime Fecha de caducidad de la oferta
Calculado automáticamente si no se informa
document
document.client String Url de un documento para entregar conductor
document.grayCard String Url de la tarjeta de circulación del vehículo
document.pickup String Url de la orden de recogida
document.expertise String Url del estado del vehículo
document.pvDelivery String Url del acta
document.pvPickup String Url del informe de adquisición
document.cerfa String Url del CERFA
option
option.takeRdv Bool Opción de cita
Solo disponible si Entrega ('tipo' = 2 o 3)
option.cleaning Bool Opción de limpieza de vehículos
Solo disponible si Entrega ('tipo' = 2 o 3)
option.demonstration Bool Opción de demostración de vehículos
Solo disponible si Entrega ('tipo' = 2 o 3)
option.w Bool Opción de placa roja provisional solicitada
Sólo disponible conductor profesional ('driverType' = 2)
note
note.user String Nota disponible para los visitantes y el futuro conductor
note.driver String Nota disponible solo para el conductor
note.driiveme String Nota disponible solo para Driiveme

Ejemplo JSON

{"idAdmin": 123,"type": 2, "driverType": 2, "idClient": "myCustomId","departure": {"fullAddress": "3 rue Clairaut, 75017 Paris", "type": 5, "name": "DriiveMe", "phone": "0102030405"},"destination": {"id": 55898},"vehicle": {"category": 2,"registration": "AB-123-YZ"},"date": {"beginAvailability":"2020-01-14 09:00:00","endDelivery":"2020-01-22 16:00:00"},"document": {"pickup": "http://www.mondomaine.com/my-doc.jpg"},"note": {"driver": "Hello World"}}

    Response    

status * Enum Estado de la consulta
OK - Búsqueda valida
KO - Se ha producido un error
error String Mensaje de error
Presente si el status = 'KO'
errorCode Int Código error
Presente si el status = 'KO'
500 - Clave API inválida
501 - Estructura JSON inválida
502 - Parámetros JSON inválidos
503 - Administrador no válido
504 - Dirección no válida
505 - Vehículo no válido
506 - Fecha no válida
510 - Otro no válido
id Int ID Driiveme de transporte creado
Presente si el status = 'OK'
price Float Precio del transporte impuestos no incluidos
Presente si el status = 'OK'
Cargando