Pojazdy usługi napędu CDK (wersja zapoznawcza)
CdK Drive Service Vehicles Kojarzy identyfikację, typ, stan i informacje o kliencie o pojeździe. Interfejs API umożliwia tworzenie, aktualizowanie, wykonywanie zapytań i pobieranie informacji o pojeździe domeny usługi w zestawie CDK.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Globalny klucz CDK |
| adres URL | https://serviceconnect.support.cdk.com |
| mbd_support@cdk.com |
| Metadane łącznika | |
|---|---|
| Publisher | Globalny klucz CDK |
| Witryna internetowa | https://fortellis.io |
| Zasady ochrony prywatności | https://fortellis.io/privacy |
| Kategorie | Dane |
Napęd CDK — usługa — pojazdy kojarzą identyfikację, typ, stan i informacje o kliencie dotyczące pojazdu.
Co robi ten interfejs API? Interfejs API umożliwia tworzenie, aktualizowanie, wykonywanie zapytań i pobieranie informacji o pojeździe domeny usługi na dysku CDK.
Zamierzony pojazd odbiorców to zależność dla przepływów pracy terminów obsługi i zamówienia naprawy usługi.
Pre-requisites
Aby kontynuować, musisz wykonać następujące czynności
• Aby korzystać z łącznika, musisz być użytkownikiem Aplikacji Fortellis.
• Należy utworzyć rozwiązanie w fortellis, aby wygenerować identyfikator klienta i wpis tajny, który ma być używany podczas wywoływania interfejsów API
Potencjalne przypadki użycia
Użyj interfejsu API pojazdów usługi CDKDrive, aby utworzyć rozwiązania do obsługi takich sytuacji jak:
- Tworzenie lub aktualizowanie informacji o pojeździe usługi
- Łączenie klienta z pojazdem serwisowym
- Wyszukiwanie istniejących pojazdów służbowych według identyfikatora lub kryteriów filtrowania
Szczegółową dokumentację można znaleźć na stronie
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie pojazdu |
Aktualizowanie pojazdu |
| Tworzenie pojazdu |
Tworzenie pojazdu |
| Wykonywanie zapytań dotyczących pojazdu według identyfikatora |
Wykonywanie zapytań dotyczących pojazdu według identyfikatora |
| Wykonywanie zapytań o pojazdy |
Wykonywanie zapytań o pojazdy |
Aktualizowanie pojazdu
Aktualizowanie pojazdu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pojazdu
|
vehicleId | True | string |
Identyfikator pojazdu |
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania. |
|
Identyfikator klienta
|
client_id | True | string |
Identyfikator klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Tajemnica klienta
|
client_secret | True | string |
Wpis tajny klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Identyfikator żądania
|
Request-Id | string |
Format — identyfikator GUID. Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania |
|
|
Wartość elementu eTag
|
If-Match | True | string |
Powoduje, że żądanie aktualizacji zasobów jest warunkowe. Wartość sumy kontrolnej przedstawiona If-Match musi być zgodna z bieżącą wartością elementu ETag zasobu. |
|
Vin
|
vin | string |
Numer idenityfikacji pojazdu |
|
|
licensePlateNum
|
licensePlateNum | string |
Numer rejestracyjny pojazdu |
|
|
makeCode
|
makeCode | True | string |
Kod pojazdu |
|
robić
|
make | string |
Nazwa pojazdu |
|
|
modelCode
|
modelCode | True | string |
Kod modelu pojazdów |
|
model
|
model | string |
Nazwa modelu pojazdów |
|
|
modelYear
|
modelYear | True | number |
Rok modelu pojazdów |
|
exteriorColor
|
exteriorColor | string |
Kolor zewnętrzny pojazdu |
|
|
value
|
value | True | number |
Wartość miary |
|
Jednostek
|
units | True | string |
Jednostki miary |
|
stan
|
status | True | string |
Czy stan pojazdu nowego, używanego lub certyfikowanego? |
|
Dostarczane
|
delivered | True | date |
Data dostawy pojazdu do bieżącego właściciela zgodnie z definicją RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
inService
|
inService | True | date |
Data sprzedaży detalicznej pierwotnego właściciela zgodnie z definicją WFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data wygaśnięcia gwarancji pojazdu zdefiniowana przez RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
Hiperłącze do zasobu klienta właściciela |
|
|
primaryDriverHref
|
primaryDriverHref | string |
Hiperlink do zasobu klienta podstawowego sterownika |
Zwraca
- Body
- Vehicle
Tworzenie pojazdu
Tworzenie pojazdu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator klienta
|
client_id | True | string |
Identyfikator klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Tajemnica klienta
|
client_secret | True | string |
Wpis tajny klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania. |
|
Identyfikator żądania
|
Request-Id | True | string |
Format — identyfikator GUID. Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania |
|
Vin
|
vin | string |
Numer idenityfikacji pojazdu |
|
|
licensePlateNum
|
licensePlateNum | string |
Numer rejestracyjny pojazdu |
|
|
makeCode
|
makeCode | True | string |
Kod pojazdu |
|
robić
|
make | string |
Nazwa pojazdu |
|
|
modelCode
|
modelCode | True | string |
Kod modelu pojazdów |
|
model
|
model | string |
Nazwa modelu pojazdów |
|
|
modelYear
|
modelYear | True | number |
Rok modelu pojazdów |
|
exteriorColor
|
exteriorColor | string |
Kolor zewnętrzny pojazdu |
|
|
value
|
value | True | number |
Wartość miary |
|
Jednostek
|
units | True | string |
Jednostki miary |
|
stan
|
status | True | string |
Czy stan pojazdu nowego, używanego lub certyfikowanego? |
|
Dostarczane
|
delivered | True | date |
Data dostawy pojazdu do bieżącego właściciela zgodnie z definicją RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
inService
|
inService | True | date |
Data sprzedaży detalicznej pierwotnego właściciela zgodnie z definicją WFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data wygaśnięcia gwarancji pojazdu zdefiniowana przez RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
Hiperłącze do zasobu klienta właściciela |
|
|
primaryDriverHref
|
primaryDriverHref | string |
Hiperlink do zasobu klienta podstawowego sterownika |
Zwraca
- Body
- Vehicle
Wykonywanie zapytań dotyczących pojazdu według identyfikatora
Wykonywanie zapytań dotyczących pojazdu według identyfikatora
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pojazdu
|
vehicleId | True | string |
Identyfikator pojazdu |
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania. |
|
Identyfikator klienta
|
client_id | True | string |
Identyfikator klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Tajemnica klienta
|
client_secret | True | string |
Wpis tajny klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Identyfikator żądania
|
Request-Id | string |
Format — identyfikator GUID. Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania |
Zwraca
- Body
- Vehicle
Wykonywanie zapytań o pojazdy
Wykonywanie zapytań o pojazdy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Vin
|
vin | string |
Filtruje pojazdy według VIN |
|
|
Numer tablicy rejestracyjnej
|
licensePlateNum | string |
Filtruje pojazdy według numeru rejestracyjnego |
|
|
Identyfikator klienta
|
customerId | string |
Filtruje pojazdy według identyfikatora customerId |
|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania. |
|
Identyfikator klienta
|
client_id | True | string |
Identyfikator klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Tajemnica klienta
|
client_secret | True | string |
Wpis tajny klienta, który powinien być unikatowy dla dewelopera/dostawcy rozwiązań tworzącego rozwiązanie. |
|
Identyfikator żądania
|
Request-Id | string |
Format — identyfikator GUID. Identyfikator korelacji, który powinien zostać zwrócony do obiektu wywołującego, aby wskazać zwrot danego żądania |
Zwraca
- Body
- VehicleCollection
Definicje
Pojazd
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
vehicleId
|
vehicleId | string |
Idenifier rekordu pojazdu |
|
identyfikacja
|
identification | VehicleIdentification |
Identyfikacja pojazdu. Co najmniej jedna z właściwości identyfikacji musi być zdefiniowana, aby jednostka miała być prawidłowa. |
|
specyfikacja
|
specification | VehicleSpecification | |
|
exteriorColor
|
exteriorColor | string |
Kolor zewnętrzny pojazdu |
|
przebieg
|
mileage | Measurement | |
|
stan
|
status | string |
Czy stan pojazdu nowego, używanego lub certyfikowanego? |
|
Daty
|
dates | Dates | |
|
ownerHref
|
ownerHref | string |
Hiperłącze do zasobu klienta właściciela |
|
primaryDriverHref
|
primaryDriverHref | string |
Hiperlink do zasobu klienta podstawowego sterownika |
|
links
|
links | VehicleLinks |
Dentyfikacja pojazdu
Identyfikacja pojazdu. Co najmniej jedna z właściwości identyfikacji musi być zdefiniowana, aby jednostka miała być prawidłowa.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Vin
|
vin | string |
Numer idenityfikacji pojazdu |
|
licensePlateNum
|
licensePlateNum | string |
Numer rejestracyjny pojazdu |
PojazduLinki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Szczegóły linku do zasobu
|
self | LinkDescriptionObject |
VehicleCollection
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
items
|
items | array of Vehicle |
VehicleSpecification
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
makeCode
|
makeCode | string |
Kod pojazdu |
|
robić
|
make | string |
Nazwa pojazdu |
|
modelCode
|
modelCode | string |
Kod modelu pojazdów |
|
model
|
model | string |
Nazwa modelu pojazdów |
|
modelYear
|
modelYear | number |
Rok modelu pojazdów |
Miara
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | number |
Wartość miary |
|
Jednostek
|
units | string |
Jednostki miary |
Daty
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dostarczane
|
delivered | date |
Data dostawy pojazdu do bieżącego właściciela zgodnie z definicją RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
inService
|
inService | date |
Data sprzedaży detalicznej pierwotnego właściciela zgodnie z definicją WFC 3339, sekcja 5.6, na przykład 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data wygaśnięcia gwarancji pojazdu zdefiniowana przez RFC 3339, sekcja 5.6, na przykład 2017-07-21 |
LinkDescriptionObject
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
href
|
href | string |
Docelowy identyfikator URI |
|
metoda
|
method | string |
Czasownik HTTP, którego należy użyć do wykonania żądania do obiektu docelowego łącza |
|
title
|
title | string |
Właściwość title zawiera tytuł linku i jest przydatnym narzędziem do dokumentacji, które ułatwia zrozumienie przez klientów końcowych |