Vehículos de servicio de unidad CDK (versión preliminar)
CdK Drive Service Vehicles Asocia la identificación, el tipo, el estado y la información del cliente sobre un vehículo. La API le permitirá crear, actualizar, consultar y recuperar información del vehículo del dominio de servicio en CDK.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | CDK Global |
| URL | https://serviceconnect.support.cdk.com |
| Correo Electrónico | mbd_support@cdk.com |
| Metadatos del conector | |
|---|---|
| Publicador | CDK Global |
| Sitio web | https://fortellis.io |
| Directiva de privacidad | https://fortellis.io/privacy |
| Categorías | Data |
Unidad CDK - Servicio - Vehículos asocia la identificación, el tipo, el estado y la información del cliente sobre un vehículo.
¿Qué hace esta API? La API le permitirá crear, actualizar, consultar y recuperar información del vehículo del dominio de servicio en la unidad CDK.
El vehículo de audiencia previsto es una dependencia para los flujos de trabajo de citas de servicio y pedido de reparación del servicio.
Requisitos previos
Necesitará lo siguiente para continuar.
• Para usar el conector, debe ser un usuario de Fortellis.
• Debe crear una solución en Fortellis para generar el identificador de cliente y el secreto que se usarán al llamar a las API.
Casos de uso potenciales
Use la API de vehículos de servicio CDKDrive para crear soluciones para controlar situaciones como:
- Creación o actualización de la información del vehículo de servicio
- Vinculación de un cliente a un vehículo de servicio
- Buscar vehículos de servicio existentes por identificador o criterios de filtro
Puede encontrar documentación detallada en
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar un vehículo |
Actualizar un vehículo |
| Consulta de un vehículo por identificador |
Consulta de un vehículo por identificador |
| Creación de un vehículo |
Creación de un vehículo |
| Vehículos de consulta |
Vehículos de consulta |
Actualizar un vehículo
Actualizar un vehículo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de vehículo
|
vehicleId | True | string |
Identificador del vehículo |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de solicitud
|
Request-Id | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
|
Valor de eTag
|
If-Match | True | string |
Hace que la solicitud de actualización de recursos sea condicional. El valor de suma de comprobación presentado con If-Match debe coincidir con el valor ETag actual del recurso. |
|
Vin
|
vin | string |
Número de idenificación del vehículo |
|
|
licensePlateNum
|
licensePlateNum | string |
Número de matrícula del vehículo |
|
|
makeCode
|
makeCode | True | string |
El código make del vehículo |
|
hacer
|
make | string |
El nombre de marca del vehículo |
|
|
modelCode
|
modelCode | True | string |
El código del modelo de vehículo |
|
model
|
model | string |
Nombre del modelo del vehículo |
|
|
modelYear
|
modelYear | True | number |
El año del modelo del vehículo |
|
exteriorColor
|
exteriorColor | string |
Color exterior del vehículo |
|
|
value
|
value | True | number |
Valor de medida |
|
unidades
|
units | True | string |
Unidades de medida |
|
estado
|
status | True | string |
¿Es el estado del vehículo nuevo, utilizado o certificado? |
|
entregado
|
delivered | True | date |
Fecha de entrega del vehículo a su propietario actual según lo definido por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
inService
|
inService | True | date |
Fecha de venta comercial al propietario original, tal como se define en RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Fecha de expiración de la garantía del vehículo definida por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
Hipervínculo al recurso del cliente propietario |
|
|
primaryDriverHref
|
primaryDriverHref | string |
Hipervínculo al recurso del cliente del controlador principal |
Devoluciones
- Body
- Vehicle
Consulta de un vehículo por identificador
Consulta de un vehículo por identificador
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de vehículo
|
vehicleId | True | string |
Identificador del vehículo |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de solicitud
|
Request-Id | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Devoluciones
- Body
- Vehicle
Creación de un vehículo
Creación de un vehículo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
Vin
|
vin | string |
Número de idenificación del vehículo |
|
|
licensePlateNum
|
licensePlateNum | string |
Número de matrícula del vehículo |
|
|
makeCode
|
makeCode | True | string |
El código make del vehículo |
|
hacer
|
make | string |
El nombre de marca del vehículo |
|
|
modelCode
|
modelCode | True | string |
El código del modelo de vehículo |
|
model
|
model | string |
Nombre del modelo del vehículo |
|
|
modelYear
|
modelYear | True | number |
El año del modelo del vehículo |
|
exteriorColor
|
exteriorColor | string |
Color exterior del vehículo |
|
|
value
|
value | True | number |
Valor de medida |
|
unidades
|
units | True | string |
Unidades de medida |
|
estado
|
status | True | string |
¿Es el estado del vehículo nuevo, utilizado o certificado? |
|
entregado
|
delivered | True | date |
Fecha de entrega del vehículo a su propietario actual según lo definido por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
inService
|
inService | True | date |
Fecha de venta comercial al propietario original, tal como se define en RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Fecha de expiración de la garantía del vehículo definida por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
Hipervínculo al recurso del cliente propietario |
|
|
primaryDriverHref
|
primaryDriverHref | string |
Hipervínculo al recurso del cliente del controlador principal |
Devoluciones
- Body
- Vehicle
Vehículos de consulta
Vehículos de consulta
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Vin
|
vin | string |
Filtra vehículos por VIN |
|
|
Número de placa de licencia
|
licensePlateNum | string |
Filtra vehículos por número de matrícula |
|
|
Id. de cliente
|
customerId | string |
Filtra vehículos por customerId |
|
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de solicitud
|
Request-Id | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Devoluciones
- Body
- VehicleCollection
Definiciones
Vehículo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
vehicleId
|
vehicleId | string |
Eldenificador del registro del vehículo |
|
identificación
|
identification | VehicleIdentification |
Identificación del vehículo. Se debe definir al menos una de las propiedades de identificación para que la entidad sea válida. |
|
especificación
|
specification | VehicleSpecification | |
|
exteriorColor
|
exteriorColor | string |
Color exterior del vehículo |
|
kilometraje
|
mileage | Measurement | |
|
estado
|
status | string |
¿Es el estado del vehículo nuevo, utilizado o certificado? |
|
Fechas
|
dates | Dates | |
|
ownerHref
|
ownerHref | string |
Hipervínculo al recurso del cliente propietario |
|
primaryDriverHref
|
primaryDriverHref | string |
Hipervínculo al recurso del cliente del controlador principal |
|
Enlaces
|
links | VehicleLinks |
VehicleIdentification
Identificación del vehículo. Se debe definir al menos una de las propiedades de identificación para que la entidad sea válida.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Vin
|
vin | string |
Número de idenificación del vehículo |
|
licensePlateNum
|
licensePlateNum | string |
Número de matrícula del vehículo |
VehicleLinks
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Detalles de un vínculo a un recurso
|
self | LinkDescriptionObject |
VehicleCollection
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Vehicle |
VehicleSpecification
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
makeCode
|
makeCode | string |
El código make del vehículo |
|
hacer
|
make | string |
El nombre de marca del vehículo |
|
modelCode
|
modelCode | string |
El código del modelo de vehículo |
|
model
|
model | string |
Nombre del modelo del vehículo |
|
modelYear
|
modelYear | number |
El año del modelo del vehículo |
Medición
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | number |
Valor de medida |
|
unidades
|
units | string |
Unidades de medida |
Fechas
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
entregado
|
delivered | date |
Fecha de entrega del vehículo a su propietario actual según lo definido por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
inService
|
inService | date |
Fecha de venta comercial al propietario original, tal como se define en RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Fecha de expiración de la garantía del vehículo definida por RFC 3339, sección 5.6, por ejemplo, 2017-07-21 |
LinkDescriptionObject
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
href
|
href | string |
URI de destino |
|
method
|
method | string |
Verbo HTTP que debe usarse para realizar una solicitud al destino del vínculo. |
|
title
|
title | string |
La propiedad title proporciona un título para el vínculo y es una herramienta de documentación útil para facilitar la comprensión por parte de los clientes finales. |