Elead Sales Customers (anteprima)
Questa API consente la gestione delle informazioni sui clienti/potenziali all'interno di Elead CRM. Questa API include le funzionalità e le funzionalità seguenti per la gestione delle informazioni su prospect/cliente, l'aggiunta di informazioni su prospect/cliente, ad esempio nome, numeri di telefono, indirizzi di posta elettronica e indirizzo fisico e restituire l'ID Elead assegnato in modo univoco al post, Aggiornare, cercare e recuperare le informazioni di contatto di prospect/cliente associate a un ID Elead esistente.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | CDK Global |
| URL | https://serviceconnect.support.cdk.com |
| mbd_support@cdk.com |
| Metadati del connettore | |
|---|---|
| Editore | CDK Global |
| Sito web | https://fortellis.io |
| Informativa sulla privacy | https://fortellis.io/privacy |
| Categorie | Data |
Che cosa fa questa API?
Questa API consente la gestione delle informazioni sui clienti/potenziali all'interno di Elead CRM.
Destinatari
Questa API è destinata ai rivenditori e ai partner fornitori che devono gestire i dati di prospect/clienti all'interno di Elead CRM.
Funzionalità e funzionalità
Questa API include le funzionalità e le funzionalità seguenti per la gestione delle informazioni sui clienti o sui potenziali clienti.
- Aggiungere informazioni sul cliente/prospettiva, ad esempio nome, numeri di telefono, indirizzi di posta elettronica e indirizzo fisico
- Aggiornare le informazioni di contatto di prospect/cliente associate a un ID Elead esistente
- Recuperare prospect/clienti in base all'ID Elead
- Cerca prospect/clienti in base al nome, all'indirizzo di posta elettronica o al numero di telefono
- Recuperare i veicoli potenziali/di proprietà del cliente in base all'ID Elead
Pre-requisites
Per procedere, sarà necessario quanto segue
- Per usare il connettore, è necessario essere un utente di Fortellis
- È necessario creare una soluzione in Fortellis per generare l'ID client e il segreto da usare durante la chiamata alle API
La documentazione dettagliata è disponibile all'indirizzo
https://apidocs.fortellis.io/specs/ba092364-accc-4ad9-865f-fac51c34cdb1
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare un cliente |
Aggiorna le informazioni sui clienti/potenziali |
| Cerca clienti |
Cerca clienti |
| Creare un cliente |
Crea un cliente/prospettiva |
| Ottenere il cliente in base all'ID |
Recupera un record di prospettiva/cliente in base all'ID cliente Elead. Un ID cliente Elead viene attualmente ottenuto come segue:
|
| Ottenere veicoli in base all'ID |
Recupera i record di un veicolo potenziale/cliente in base all'ID cliente Elead. Un ID cliente Elead viene attualmente ottenuto come segue:
|
Aggiornare un cliente
Aggiorna le informazioni sui clienti/potenziali
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID cliente
|
customerId | True | string |
Formato : uuid. |
|
ID Client
|
client_id | True | string |
ID client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
Segreto del cliente
|
client_secret | True | string |
Segreto client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
ID sottoscrizione
|
subscription_id | True | string |
ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata. |
|
Accettare
|
Accept | string |
Accetta intestazione |
|
|
Accept-Charset
|
Accept-Charset | string |
Intestazione Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Intestazione Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Intestazione Accept-Language |
|
|
If-Match
|
If-Match | string |
Intestazione If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Intestazione If-None-Match |
|
|
Preferire
|
Prefer | string |
Preferenza del cliente |
|
|
ID richiesta
|
Request-Id | True | string |
Formato - GUID. ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata |
|
isBusiness
|
isBusiness | boolean |
true/false se il cliente è un'azienda |
|
|
businessName
|
businessName | string |
Nome dell'azienda, impostare quando isBusiness è true |
|
|
businessContact
|
businessContact | string |
Nome della persona di contatto aziendale, impostata quando isBusiness è true |
|
|
title
|
title | string |
Titolo del cliente |
|
|
nome
|
firstName | string |
Nome di battesimo cliente |
|
|
secondo nome
|
middleName | string |
Nome intermedio del cliente |
|
|
lastName
|
lastName | string |
Cognome del cliente |
|
|
soprannome
|
nickname | string |
Nome alternativo del cliente |
|
|
compleanno
|
birthday | date-time |
Compleanno del cliente |
|
|
address
|
address | True | string |
Indirizzo di posta elettronica del cliente |
|
emailType
|
emailType | True | string | |
|
doNotEmail
|
doNotEmail | boolean |
true/false per contrassegnare come Non inviare un messaggio di posta elettronica |
|
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo di posta elettronica preferito del cliente |
|
|
numero
|
number | True | string |
Numero di telefono |
|
phoneType
|
phoneType | True | string | |
|
preferredTimeToContact
|
preferredTimeToContact | True | string | |
|
doNotCall
|
doNotCall | boolean |
true/false per contrassegnare come Non chiamare |
|
|
doNotText
|
doNotText | boolean |
true/false per contrassegnare come Non testo |
|
|
preferCall
|
preferCall | boolean |
true/false se il cliente preferisce essere contattato tramite telefono |
|
|
preferText
|
preferText | boolean |
true/false se il cliente preferisce essere contattato tramite testo |
|
|
indirizzoLinea1
|
addressLine1 | string |
Indirizzo cliente, linea 1 |
|
|
indirizzoLinea2
|
addressLine2 | string |
Indirizzo cliente riga 2 |
|
|
city
|
city | string |
Città del cliente |
|
|
state
|
state | string |
Stato/Provincia del cliente |
|
|
formato zip
|
zip | True | string |
Codice postale del cliente |
|
country
|
country | string |
Paese del cliente |
|
|
contea
|
county | string |
Contea del cliente |
|
|
doNotMail
|
doNotMail | boolean |
true/false per contrassegnare come Non inviare messaggi |
|
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo preferito del cliente |
Restituisce
- Corpo
- Customer
Cerca clienti
Cerca clienti
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Formato : int32. |
|
|
Dimensioni pagina
|
pageSize | integer |
Formato : int32. |
|
|
ID Client
|
client_id | True | string |
ID client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
Segreto del cliente
|
client_secret | True | string |
Segreto client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
ID sottoscrizione
|
subscription_id | True | string |
ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata. |
|
Accettare
|
Accept | string |
Accetta intestazione |
|
|
Accept-Charset
|
Accept-Charset | string |
Intestazione Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Intestazione Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Intestazione Accept-Language |
|
|
If-Match
|
If-Match | string |
Intestazione If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Intestazione If-None-Match |
|
|
Preferire
|
Prefer | string |
Preferenza del cliente |
|
|
ID richiesta
|
Request-Id | True | string |
Formato - GUID. ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata |
|
nome
|
firstName | string |
Stringa di ricerca per il nome del cliente |
|
|
lastName
|
lastName | string |
Stringa di ricerca per il cognome del cliente |
|
|
numero di telefono
|
phoneNumber | string |
Stringa di ricerca per il numero di telefono del cliente |
|
|
indirizzo email
|
emailAddress | string |
Stringa di ricerca per l'indirizzo di posta elettronica del cliente |
Restituisce
- Corpo
- SearchCustomersResponse
Creare un cliente
Crea un cliente/prospettiva
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID Client
|
client_id | True | string |
ID client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
Segreto del cliente
|
client_secret | True | string |
Segreto client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
ID sottoscrizione
|
subscription_id | True | string |
ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata. |
|
Accettare
|
Accept | string |
Accetta intestazione |
|
|
Accept-Charset
|
Accept-Charset | string |
Intestazione Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Intestazione Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Intestazione Accept-Language |
|
|
If-Match
|
If-Match | string |
Intestazione If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Intestazione If-None-Match |
|
|
Preferire
|
Prefer | string |
Preferenza del cliente |
|
|
ID richiesta
|
Request-Id | True | string |
Formato - GUID. ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata |
|
isBusiness
|
isBusiness | boolean |
true/false se il cliente è un'azienda |
|
|
businessName
|
businessName | string |
Nome dell'azienda, impostare quando isBusiness è true |
|
|
businessContact
|
businessContact | string |
Nome della persona di contatto aziendale, impostata quando isBusiness è true |
|
|
title
|
title | string |
Titolo del cliente |
|
|
nome
|
firstName | string |
Nome di battesimo cliente |
|
|
secondo nome
|
middleName | string |
Nome intermedio del cliente |
|
|
lastName
|
lastName | string |
Cognome del cliente |
|
|
soprannome
|
nickname | string |
Nome alternativo del cliente |
|
|
compleanno
|
birthday | date-time |
Compleanno del cliente |
|
|
address
|
address | True | string |
Indirizzo di posta elettronica del cliente |
|
emailType
|
emailType | True | string | |
|
doNotEmail
|
doNotEmail | boolean |
true/false per contrassegnare come Non inviare un messaggio di posta elettronica |
|
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo di posta elettronica preferito del cliente |
|
|
numero
|
number | True | string |
Numero di telefono |
|
phoneType
|
phoneType | True | string | |
|
preferredTimeToContact
|
preferredTimeToContact | True | string | |
|
doNotCall
|
doNotCall | boolean |
true/false per contrassegnare come Non chiamare |
|
|
doNotText
|
doNotText | boolean |
true/false per contrassegnare come Non testo |
|
|
preferCall
|
preferCall | boolean |
true/false se il cliente preferisce essere contattato tramite telefono |
|
|
preferText
|
preferText | boolean |
true/false se il cliente preferisce essere contattato tramite testo |
|
|
indirizzoLinea1
|
addressLine1 | string |
Indirizzo cliente, linea 1 |
|
|
indirizzoLinea2
|
addressLine2 | string |
Indirizzo cliente riga 2 |
|
|
city
|
city | string |
Città del cliente |
|
|
state
|
state | string |
Stato/Provincia del cliente |
|
|
formato zip
|
zip | True | string |
Codice postale del cliente |
|
country
|
country | string |
Paese del cliente |
|
|
contea
|
county | string |
Contea del cliente |
|
|
doNotMail
|
doNotMail | boolean |
true/false per contrassegnare come Non inviare messaggi |
|
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo preferito del cliente |
Restituisce
- Corpo
- Customer
Ottenere il cliente in base all'ID
Recupera un record di prospettiva/cliente in base all'ID cliente Elead. Un ID cliente Elead viene attualmente ottenuto come segue:
Creare un cliente tramite POST /sales/v1/elead/customers
Opportunità di ricerca tramite GET /sales/v1/elead/opportunities/search
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID cliente
|
customerId | True | string |
Formato : uuid. |
|
ID Client
|
client_id | True | string |
ID client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
Segreto del cliente
|
client_secret | True | string |
Segreto client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
ID sottoscrizione
|
subscription_id | True | string |
ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata. |
|
Accettare
|
Accept | string |
Accetta intestazione |
|
|
Accept-Charset
|
Accept-Charset | string |
Intestazione Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Intestazione Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Intestazione Accept-Language |
|
|
If-Match
|
If-Match | string |
Intestazione If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Intestazione If-None-Match |
|
|
Preferire
|
Prefer | string |
Preferenza del cliente |
|
|
ID richiesta
|
Request-Id | True | string |
Formato - GUID. ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata |
Restituisce
- Corpo
- Customer
Ottenere veicoli in base all'ID
Recupera i record di un veicolo potenziale/cliente in base all'ID cliente Elead. Un ID cliente Elead viene attualmente ottenuto come segue:
Creare un cliente tramite POST /sales/v1/elead/customers
Opportunità di ricerca tramite GET /sales/v1/elead/opportunities/search
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID cliente
|
customerId | True | string |
Formato : uuid. |
|
ID Client
|
client_id | True | string |
ID client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
Segreto del cliente
|
client_secret | True | string |
Segreto client che deve essere univoco per lo sviluppatore/provider di soluzioni che compila la soluzione. |
|
ID sottoscrizione
|
subscription_id | True | string |
ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata. |
|
Accettare
|
Accept | string |
Accetta intestazione |
|
|
Accept-Charset
|
Accept-Charset | string |
Intestazione Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Intestazione Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Intestazione Accept-Language |
|
|
If-Match
|
If-Match | string |
Intestazione If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Intestazione If-None-Match |
|
|
Preferire
|
Prefer | string |
Preferenza del cliente |
|
|
ID richiesta
|
Request-Id | True | string |
Formato - GUID. ID di correlazione che deve essere restituito al chiamante per indicare la restituzione della richiesta specificata |
Restituisce
Definizioni
Cliente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | uuid |
Identificatore univoco del cliente |
|
isBusiness
|
isBusiness | boolean |
true/false se il cliente è un'azienda |
|
businessName
|
businessName | string |
Nome dell'azienda, impostare quando isBusiness è true |
|
businessContact
|
businessContact | string |
Nome della persona di contatto aziendale, impostata quando isBusiness è true |
|
title
|
title | string |
Titolo del cliente |
|
nome
|
firstName | string |
Nome di battesimo cliente |
|
secondo nome
|
middleName | string |
Nome intermedio del cliente |
|
lastName
|
lastName | string |
Cognome del cliente |
|
soprannome
|
nickname | string |
Nome alternativo del cliente |
|
compleanno
|
birthday | date-time |
Compleanno del cliente |
|
messaggi di posta elettronica
|
emails | array of CustomerEmail |
Indirizzo di posta elettronica del cliente |
|
Telefoni
|
phones | array of CustomerPhone |
Numeri di telefono del cliente |
|
address
|
address | CustomerAddress | |
|
links
|
links | array of LinkDescriptionObject |
Raccolta di collegamenti HATEOAS |
Email del Cliente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
address
|
address | string |
Indirizzo di posta elettronica del cliente |
|
emailType
|
emailType | string | |
|
doNotEmail
|
doNotEmail | boolean |
true/false per contrassegnare come Non inviare un messaggio di posta elettronica |
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo di posta elettronica preferito del cliente |
CustomerPhone
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
numero
|
number | string |
Numero di telefono |
|
phoneType
|
phoneType | string | |
|
preferredTimeToContact
|
preferredTimeToContact | string | |
|
doNotCall
|
doNotCall | boolean |
true/false per contrassegnare come Non chiamare |
|
doNotText
|
doNotText | boolean |
true/false per contrassegnare come Non testo |
|
preferCall
|
preferCall | boolean |
true/false se il cliente preferisce essere contattato tramite telefono |
|
preferText
|
preferText | boolean |
true/false se il cliente preferisce essere contattato tramite testo |
IndirizzoCliente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
indirizzoLinea1
|
addressLine1 | string |
Indirizzo cliente, linea 1 |
|
indirizzoLinea2
|
addressLine2 | string |
Indirizzo cliente riga 2 |
|
city
|
city | string |
Città del cliente |
|
state
|
state | string |
Stato/Provincia del cliente |
|
formato zip
|
zip | string |
Codice postale del cliente |
|
country
|
country | string |
Paese del cliente |
|
contea
|
county | string |
Contea del cliente |
|
doNotMail
|
doNotMail | boolean |
true/false per contrassegnare come Non inviare messaggi |
|
isPreferred
|
isPreferred | boolean |
true/false se si tratta dell'indirizzo preferito del cliente |
SearchCustomersResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
items
|
items | array of SearchCustomer |
Raccolta di risultati della ricerca dei clienti |
|
totalItems
|
totalItems | integer |
Numero totale di clienti per la ricerca specificata |
|
totalPages
|
totalPages | integer |
Numero totale di pagine di clienti per la ricerca specificata |
|
pageNumber
|
pageNumber | integer |
Numero di pagina corrente per questo set di risultati di paging |
|
pageSize
|
pageSize | integer |
Dimensioni pagina per questo set di risultati di paging |
|
links
|
links | array of LinkDescriptionObject |
Raccolta di collegamenti HATEOAS |
SearchCustomer
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | uuid |
Identificatore univoco per il cliente |
|
nome
|
firstName | string |
Nome di battesimo cliente |
|
lastName
|
lastName | string |
Cognome del cliente |
|
messaggi di posta elettronica
|
emails | array of CustomerEmail |
Indirizzo di posta elettronica del cliente |
|
Telefoni
|
phones | array of CustomerPhone |
Numeri di telefono del cliente |
|
address
|
address | CustomerAddress | |
|
rango
|
rank | float |
Classificazione della pertinenza del risultato della ricerca cliente |
CustomerVehicleCollection
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | uuid |
Identificatore univoco per questo veicolo |
|
exteriorColor
|
exteriorColor | string |
Colore esterno del veicolo |
|
interiorColor
|
interiorColor | string |
Colore interno del veicolo |
|
chilometraggio
|
mileage | integer |
Chilometraggio del veicolo |
|
milesPerWeek
|
milesPerWeek | integer |
Miglia medie guidate alla settimana |
|
anno
|
year | integer |
Anno di produzione |
|
fare
|
make | string |
Marchio del veicolo |
|
model
|
model | string |
Nome del veicolo |
|
Trim
|
trim | integer |
Descrizione del taglio |
|
Vin
|
vin | string |
Numero di identificazione del veicolo |
|
options
|
options | CustomerVehicleOptions |
Opzioni del veicolo |
|
vehicleOwner
|
vehicleOwner | CustomerVehicleOwner |
Proprietario del veicolo |
CustomerVehicleOptions
Opzioni del veicolo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
fuelType
|
fuelType | string |
Tipo di carburante |
|
interiorType
|
interiorType | string |
Tipo di interno |
|
vehicleCondition
|
vehicleCondition | string |
Condizione del veicolo |
|
bodyStyle
|
bodyStyle | string |
Stile del corpo del veicolo |
|
engineDescription
|
engineDescription | string |
Tipo di motore |
|
modelCode
|
modelCode | string |
Codice del modello |
|
numberOfCylinders
|
numberOfCylinders | integer |
Numero di cilindri |
|
numberOfDoors
|
numberOfDoors | byte |
Numero di porte |
|
Trasmissione
|
transmission | string |
Tipo di trasmissione |
|
isAutomaticTransmission
|
isAutomaticTransmission | boolean |
true/false se il veicolo ha una trasmissione automatica |
|
hasAirBags
|
hasAirBags | boolean |
true/false se il veicolo ha borse d'aria |
|
hasCruiseControl
|
hasCruiseControl | boolean |
true/false se il veicolo ha il controllo della crociera |
|
hasAirConditioning
|
hasAirConditioning | boolean |
true/false se il veicolo ha aria condizionata |
CustomerVehicleOwner
Proprietario del veicolo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
isActive
|
isActive | boolean |
true/false se il proprietario è attivo |
|
customerId
|
customerId | uuid |
Identificatore univoco per il proprietario del veicolo |
|
vehicleId
|
vehicleId | uuid |
Identificatore univoco per il veicolo |
LinkDescriptionObject
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
href
|
href | string |
URI di destinazione |
|
Rel
|
rel | string |
Tipo di relazione di collegamento |
|
method
|
method | string |
Verbo HTTP che DEVE essere usato per effettuare una richiesta alla destinazione del collegamento |
|
title
|
title | string |
Titolo che descrive l'oggetto |