Udostępnij przez


Klienci sprzedaży usługi Elead (wersja zapoznawcza)

Ten interfejs API umożliwia zarządzanie informacjami o potencjalnych klientach w usłudze Elead CRM. Ten interfejs API obejmuje następujące możliwości i funkcje zarządzania informacjami o potencjalnych klientach, Dodawanie informacji o perspektywie/kliencie, takich jak imię i nazwisko, numery telefonów, adresy e-mail i adres fizyczny oraz zwracanie unikatowo przypisanego identyfikatora Elead po wpisie, aktualizowanie, wyszukiwanie, wyszukiwanie i pobieranie informacji kontaktowych klienta powiązanych z istniejącym identyfikatorem Elead.

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
Email 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

Co robi ten interfejs API?

Ten interfejs API umożliwia zarządzanie informacjami o potencjalnych klientach w usłudze Elead CRM.

Odbiorcy

Ten interfejs API jest przeznaczony dla dealerów i partnerów dostawców, którzy muszą zarządzać danymi klientów/perspektyw w usłudze Elead CRM.

Możliwości i funkcje

Ten interfejs API obejmuje następujące możliwości i funkcje do zarządzania informacjami o perspektywach/klientach.

  • Dodawanie informacji o potencjalnych klientach, takich jak imię i nazwisko, numery telefonów, adresy e-mail i adres fizyczny
  • Aktualizowanie informacji kontaktowych klienta/potencjalnych klientów powiązanych z istniejącym identyfikatorem Elead
  • Pobieranie potencjalnych klientów według identyfikatora Elead
  • Wyszukaj perspektywy/klientów według ich nazwiska, adresu e-mail lub numeru telefonu
  • Pobieranie pojazdów należących do klienta/potencjalnych klientów według identyfikatora Elead

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 systemie Fortellis, aby wygenerować identyfikator klienta i klucz tajny do użycia podczas wywoływania interfejsów API

Szczegółową dokumentację można znaleźć na stronie

https://apidocs.fortellis.io/specs/ba092364-accc-4ad9-865f-fac51c34cdb1

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie klienta

Aktualizacje — perspektywa/informacje o klientach

Pobieranie klienta według identyfikatora

Pobiera rekord perspektywy/klienta według identyfikatora klienta Elead. Identyfikator klienta Elead jest obecnie uzyskiwany w następujący sposób:

  • Tworzenie klienta za pośrednictwem adresu POST /sales/v1/elead/customers

  • Wyszukiwanie szans sprzedaży za pośrednictwem polecenia GET /sales/v1/elead/opportunities/search

Pobieranie pojazdów według identyfikatora

Pobiera rekordy potencjalnych klientów/pojazdów według identyfikatora klienta Elead. Identyfikator klienta Elead jest obecnie uzyskiwany w następujący sposób:

  • Tworzenie klienta za pośrednictwem adresu POST /sales/v1/elead/customers

  • Wyszukiwanie szans sprzedaży za pośrednictwem polecenia GET /sales/v1/elead/opportunities/search

Tworzenie klienta

Tworzy perspektywę/klienta

Wyszukiwanie klientów

Wyszukiwanie klientów

Aktualizowanie klienta

Aktualizacje — perspektywa/informacje o klientach

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator klienta
customerId True string

Format — uuid.

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.

Akceptuj
Accept string

Zaakceptuj nagłówek

Accept-Charset
Accept-Charset string

nagłówek Accept-Charset

Accept-Encoding
Accept-Encoding string

nagłówek Accept-Encoding

Accept-Language
Accept-Language string

nagłówek Accept-Language

If-Match
If-Match string

nagłówek If-Match

If-None-Match
If-None-Match string

Nagłówek if-None-Match

Woleć
Prefer string

Preferencje klienta

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

isBusiness
isBusiness boolean

prawda/fałsz, czy ten klient jest firmą

businessName
businessName string

Nazwa firmy, ustawiona, gdy wartość isBusiness ma wartość true

businessContact
businessContact string

Imię i nazwisko osoby kontaktowej, ustawiane, gdy wartość isBusiness ma wartość true

title
title string

Tytuł klienta

imię
firstName string

Imię klienta

drugie imię
middleName string

Imię i nazwisko klienta

nazwisko
lastName string

Nazwisko klienta

nick
nickname string

Pseudonim klienta

urodziny
birthday date-time

Urodziny klienta

address
address True string

Adres e-mail klienta

typ adresu e-mail
emailType True string
doNotEmail
doNotEmail boolean

prawda/fałsz do flagi jako Nie wysyłaj wiadomości e-mail

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres e-mail klienta

Liczba
number True string

Numer telefonu

phoneType
phoneType True string
preferredTimeToContact
preferredTimeToContact True string
doNotCall
doNotCall boolean

prawda/fałsz do flagi jako Nie wywoływanie

doNotText
doNotText boolean

prawda/fałsz do flagi jako Nie tekst

preferCall
preferCall boolean

prawda/fałsz, czy klient woli skontaktować się telefonicznie

preferuj tekst
preferText boolean

prawda/fałsz, czy klient woli skontaktować się z tekstem

Wiersz adresu1
addressLine1 string

Linia adresowa klienta 1

Wiersz adresu2
addressLine2 string

Druga linia adresu klienta

city
city string

Miasto klienta

stan
state string

Stan klienta

zip
zip True string

Kod pocztowy klienta

country
country string

Kraj klienta

hrabstwo
county string

Hrabstwo klienta

doNotMail
doNotMail boolean

prawda/fałsz do flagi jako Nie wyślij poczty

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres klienta

Zwraca

Body
Customer

Pobieranie klienta według identyfikatora

Pobiera rekord perspektywy/klienta według identyfikatora klienta Elead. Identyfikator klienta Elead jest obecnie uzyskiwany w następujący sposób:

  • Tworzenie klienta za pośrednictwem adresu POST /sales/v1/elead/customers

  • Wyszukiwanie szans sprzedaży za pośrednictwem polecenia GET /sales/v1/elead/opportunities/search

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator klienta
customerId True string

Format — uuid.

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.

Akceptuj
Accept string

Zaakceptuj nagłówek

Accept-Charset
Accept-Charset string

nagłówek Accept-Charset

Accept-Encoding
Accept-Encoding string

nagłówek Accept-Encoding

Accept-Language
Accept-Language string

nagłówek Accept-Language

If-Match
If-Match string

nagłówek If-Match

If-None-Match
If-None-Match string

Nagłówek if-None-Match

Woleć
Prefer string

Preferencje klienta

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

Zwraca

Body
Customer

Pobieranie pojazdów według identyfikatora

Pobiera rekordy potencjalnych klientów/pojazdów według identyfikatora klienta Elead. Identyfikator klienta Elead jest obecnie uzyskiwany w następujący sposób:

  • Tworzenie klienta za pośrednictwem adresu POST /sales/v1/elead/customers

  • Wyszukiwanie szans sprzedaży za pośrednictwem polecenia GET /sales/v1/elead/opportunities/search

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator klienta
customerId True string

Format — uuid.

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.

Akceptuj
Accept string

Zaakceptuj nagłówek

Accept-Charset
Accept-Charset string

nagłówek Accept-Charset

Accept-Encoding
Accept-Encoding string

nagłówek Accept-Encoding

Accept-Language
Accept-Language string

nagłówek Accept-Language

If-Match
If-Match string

nagłówek If-Match

If-None-Match
If-None-Match string

Nagłówek if-None-Match

Woleć
Prefer string

Preferencje klienta

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

Zwraca

Tworzenie klienta

Tworzy perspektywę/klienta

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.

Akceptuj
Accept string

Zaakceptuj nagłówek

Accept-Charset
Accept-Charset string

nagłówek Accept-Charset

Accept-Encoding
Accept-Encoding string

nagłówek Accept-Encoding

Accept-Language
Accept-Language string

nagłówek Accept-Language

If-Match
If-Match string

nagłówek If-Match

If-None-Match
If-None-Match string

Nagłówek if-None-Match

Woleć
Prefer string

Preferencje klienta

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

isBusiness
isBusiness boolean

prawda/fałsz, czy ten klient jest firmą

businessName
businessName string

Nazwa firmy, ustawiona, gdy wartość isBusiness ma wartość true

businessContact
businessContact string

Imię i nazwisko osoby kontaktowej, ustawiane, gdy wartość isBusiness ma wartość true

title
title string

Tytuł klienta

imię
firstName string

Imię klienta

drugie imię
middleName string

Imię i nazwisko klienta

nazwisko
lastName string

Nazwisko klienta

nick
nickname string

Pseudonim klienta

urodziny
birthday date-time

Urodziny klienta

address
address True string

Adres e-mail klienta

typ adresu e-mail
emailType True string
doNotEmail
doNotEmail boolean

prawda/fałsz do flagi jako Nie wysyłaj wiadomości e-mail

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres e-mail klienta

Liczba
number True string

Numer telefonu

phoneType
phoneType True string
preferredTimeToContact
preferredTimeToContact True string
doNotCall
doNotCall boolean

prawda/fałsz do flagi jako Nie wywoływanie

doNotText
doNotText boolean

prawda/fałsz do flagi jako Nie tekst

preferCall
preferCall boolean

prawda/fałsz, czy klient woli skontaktować się telefonicznie

preferuj tekst
preferText boolean

prawda/fałsz, czy klient woli skontaktować się z tekstem

Wiersz adresu1
addressLine1 string

Linia adresowa klienta 1

Wiersz adresu2
addressLine2 string

Druga linia adresu klienta

city
city string

Miasto klienta

stan
state string

Stan klienta

zip
zip True string

Kod pocztowy klienta

country
country string

Kraj klienta

hrabstwo
county string

Hrabstwo klienta

doNotMail
doNotMail boolean

prawda/fałsz do flagi jako Nie wyślij poczty

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres klienta

Zwraca

Body
Customer

Wyszukiwanie klientów

Wyszukiwanie klientów

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
page integer

Format — int32.

Rozmiar strony
pageSize integer

Format — int32.

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.

Akceptuj
Accept string

Zaakceptuj nagłówek

Accept-Charset
Accept-Charset string

nagłówek Accept-Charset

Accept-Encoding
Accept-Encoding string

nagłówek Accept-Encoding

Accept-Language
Accept-Language string

nagłówek Accept-Language

If-Match
If-Match string

nagłówek If-Match

If-None-Match
If-None-Match string

Nagłówek if-None-Match

Woleć
Prefer string

Preferencje klienta

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

imię
firstName string

Ciąg wyszukiwania pierwszego imienia klienta

nazwisko
lastName string

Ciąg wyszukiwania nazwiska klienta

numer telefonu
phoneNumber string

Ciąg wyszukiwania numeru telefonu klienta

adres e-mail
emailAddress string

Ciąg wyszukiwania adresu e-mail klienta

Zwraca

Definicje

Klient

Nazwa Ścieżka Typ Opis
id
id uuid

Unikatowy identyfikator klienta

isBusiness
isBusiness boolean

prawda/fałsz, czy ten klient jest firmą

businessName
businessName string

Nazwa firmy, ustawiona, gdy wartość isBusiness ma wartość true

businessContact
businessContact string

Imię i nazwisko osoby kontaktowej, ustawiane, gdy wartość isBusiness ma wartość true

title
title string

Tytuł klienta

imię
firstName string

Imię klienta

drugie imię
middleName string

Imię i nazwisko klienta

nazwisko
lastName string

Nazwisko klienta

nick
nickname string

Pseudonim klienta

urodziny
birthday date-time

Urodziny klienta

wiadomości e-mail
emails array of CustomerEmail

Adresy e-mail klienta

Telefony
phones array of CustomerPhone

Numery telefonów klienta

address
address CustomerAddress
links
links array of LinkDescriptionObject

Kolekcja linków HATEOAS

Email klienta

Nazwa Ścieżka Typ Opis
address
address string

Adres e-mail klienta

typ adresu e-mail
emailType string
doNotEmail
doNotEmail boolean

prawda/fałsz do flagi jako Nie wysyłaj wiadomości e-mail

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres e-mail klienta

Telefon klienta

Nazwa Ścieżka Typ Opis
Liczba
number string

Numer telefonu

phoneType
phoneType string
preferredTimeToContact
preferredTimeToContact string
doNotCall
doNotCall boolean

prawda/fałsz do flagi jako Nie wywoływanie

doNotText
doNotText boolean

prawda/fałsz do flagi jako Nie tekst

preferCall
preferCall boolean

prawda/fałsz, czy klient woli skontaktować się telefonicznie

preferuj tekst
preferText boolean

prawda/fałsz, czy klient woli skontaktować się z tekstem

CustomerAddress

Nazwa Ścieżka Typ Opis
Wiersz adresu1
addressLine1 string

Linia adresowa klienta 1

Wiersz adresu2
addressLine2 string

Druga linia adresu klienta

city
city string

Miasto klienta

stan
state string

Stan klienta

zip
zip string

Kod pocztowy klienta

country
country string

Kraj klienta

hrabstwo
county string

Hrabstwo klienta

doNotMail
doNotMail boolean

prawda/fałsz do flagi jako Nie wyślij poczty

isPreferred
isPreferred boolean

prawda/fałsz, czy jest to preferowany adres klienta

SearchCustomersResponse

Nazwa Ścieżka Typ Opis
items
items array of SearchCustomer

Kolekcja wyników wyszukiwania klientów

Łączna liczba elementów
totalItems integer

Łączna liczba klientów dla danego wyszukiwania

totalPages
totalPages integer

Łączna liczba stron klientów dla danego wyszukiwania

pageNumber
pageNumber integer

Bieżący numer strony dla tego zestawu stronicowanych wyników

pageSize
pageSize integer

Rozmiar strony dla tego zestawu stronicowanych wyników

links
links array of LinkDescriptionObject

Kolekcja linków HATEOAS

SearchCustomer

Nazwa Ścieżka Typ Opis
id
id uuid

Unikatowy identyfikator tego klienta

imię
firstName string

Imię klienta

nazwisko
lastName string

Nazwisko klienta

wiadomości e-mail
emails array of CustomerEmail

Adres e-mail klienta

Telefony
phones array of CustomerPhone

Numery telefonów klienta

address
address CustomerAddress
pozycjonować
rank float

Trafność klasyfikacji tego wyniku wyszukiwania klientów

CustomerVehicleCollection

Nazwa Ścieżka Typ Opis
id
id uuid

Unikatowy identyfikator tego pojazdu

exteriorColor
exteriorColor string

Kolor zewnętrzny pojazdu

interiorColor
interiorColor string

Kolor wnętrza pojazdu

przebieg
mileage integer

Przebieg pojazdu

milesPerWeek
milesPerWeek integer

Średnia liczba mil wyprzedanych tygodniowo

rok
year integer

Rok produkcji

robić
make string

Marka pojazdu

model
model string

Nazwa pojazdu

przycinać
trim integer

Opis przycinania

Vin
vin string

Numer identyfikacyjny pojazdu

options
options CustomerVehicleOptions

Opcje pojazdów

właściciel pojazdu
vehicleOwner CustomerVehicleOwner

Właściciel pojazdu

CustomerVehicleOptions

Opcje pojazdów

Nazwa Ścieżka Typ Opis
fuelType
fuelType string

Typ paliwa

interiorType
interiorType string

Typ wnętrza

vehicleCondition
vehicleCondition string

Stan pojazdu

bodyStyle
bodyStyle string

Styl pojazdu

engineDescription
engineDescription string

Typ aparatu

modelCode
modelCode string

Kod modelu

numberOfCylinders
numberOfCylinders integer

Liczba cylindrów

numberOfDoors
numberOfDoors byte

Liczba drzwi

Transmisja
transmission string

Typ transmisji

isAutomaticTransmission
isAutomaticTransmission boolean

prawda/fałsz, czy pojazd ma automatyczną skrzynię biegów

hasAirBags
hasAirBags boolean

prawda/fałsz, czy pojazd ma poduszki powietrzne

hasCruiseControl
hasCruiseControl boolean

prawda/fałsz, czy pojazd ma tempomat

hasAirConditioning
hasAirConditioning boolean

prawda/fałsz, czy pojazd ma klimatyzację

CustomerVehicleOwner

Właściciel pojazdu

Nazwa Ścieżka Typ Opis
isActive
isActive boolean

prawda/fałsz, czy właściciel jest aktywny

customerId
customerId uuid

Unikatowy identyfikator właściciela pojazdu

vehicleId
vehicleId uuid

Unikatowy identyfikator pojazdu

LinkDescriptionObject

Nazwa Ścieżka Typ Opis
href
href string

Docelowy identyfikator URI

Rel
rel string

Typ relacji łącza

metoda
method string

Czasownik HTTP, którego należy użyć do wykonania żądania do obiektu docelowego łącza

title
title string

Tytuł opisujący obiekt