- Stampa
::: (info) () Per scaricare l'applicazione, visitare: Biblioteca:::
Introduzione
Salesforce è una piattaforma software CRM basata su cloud, utilizzata in applicazioni che vanno dal monitoraggio dei lead di vendita alla gestione degli ordini e dell'inventario.
Scopo
Questo documento illustra il connettore API REST di Salesforce presente nella libreria Tulip. Una volta configurate, queste funzioni del connettore possono essere utilizzate per recuperare, interrogare e modificare i dati di Salesforce da un'applicazione Tulip.
Documentazione API
La documentazione dell'API REST di Salesforce è disponibile qui. Si noti che alcune funzioni del connettore incluse in questo articolo eseguono interrogazioni utilizzando SOQL (Salesforce Object Query Language), la cui sintassi completa è documentata qui.
:::(Info) (Variazioni API) Nota: Salesforce supporta una serie di API attraverso una varietà di metodi, il cui elenco completo è disponibile qui.
Questo articolo e i connettori a cui è collegato sono costruiti per utilizzare l'API REST di Salesforce.
:::
Prima configurazione
:::(Warning) (Avviso sui permessi) Attenzione: la generazione dei seguenti valori richiede permessi a livello di sviluppatore o di amministratore in Salesforce. ::: L'autenticazione API di Salesforce segue gli standard OAuth 2.0. La seguente procedura illustra come generare un token di aggiornamento, che sarà poi utilizzato da qualsiasi app Tulip per recuperare il token di accesso necessario per connettersi con successo a Salesforce.
- Creare un'app connessa in Salesforce. A tal fine, andate nell'area "Setup" di Salesforce. Quindi, andate su PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps.
- Creare una nuova app connessa. Includere
a. tutti gli ambiti richiesti dalla vostra applicazione, ma assicuratevi di includererefresh_token
. b. Selezionate Enable OAuth Settings e inserite l'URL di callback comehttps://login.salesforce.com/services/oauth2/success.
- Una volta completato, fare clic su Manage Consumer Details per visualizzare la "Consumer Key" e il "Consumer Secret". Questi saranno utilizzati in seguito.
- Ora in Tulip, aprire la funzione Connector [Setup] Get Auth Code URL. Copiare e incollare la "Consumer Key" generata al punto 3 come parametro query
client_id
. - "Eseguire la funzione Connector.
- Osservare che è stato generato un URL come "output" del Connector. Incollare questo URL nella finestra del browser.
- Completate la richiesta di autenticazione che appare per autorizzare Tulip a interagire con la vostra istanza Salesforce.
- In caso di successo, il browser dovrebbe reindirizzare a una nuova pagina con la dicitura
Autorizzazione dell'applicazione di accesso remoto
. Il codice di autorizzazione si trova nell'URL di questa pagina.
Ad esempio, nell'URLhttps://login.salesforce.com/services/oauth2/success?code=asdf1234
il codice di autorizzazione èasdf1234
. - Salvare il codice di autorizzazione. Si noti che il codice deve terminare con due simboli di uguale:
==
. Se il codice termina con%3D%3D
, rimuovere questi caratteri e sostituirli con==
. - Passare alla funzione [Setup] Get Refresh Token Tulip Connector. Nei parametri della query, incollare tutte le informazioni raccolte in precedenza:
grant_type=
authorization_code
redirect_uri=
https://login.salesforce.com/services/oauth2/success
client_id=
la chiave del consumatore dal passo 3 di cui sopraclient_secret=
il segreto del consumatore dal passo 3 precedentecode=
il codice di autorizzazione dal precedente passo 9
- Eseguire questo connettore e salvare il
refresh_token
che appare nella risposta. - Infine, passare alla funzione [Auth] Get Access Token Connector. Compilare i seguenti parametri della query:
grant_type=
authorization_code
client_id=
la chiave del consumatore di cui al precedente punto 3client_secret=
il segreto del consumatore di cui al punto 3 precedenterefresh_token=
il token di aggiornamento di cui al precedente passo 10
- Eseguire il connettore. Si noti che la risposta include un
access_token
, che viene mappato come output. Salvare il connettore per salvare il token di aggiornamento
Una volta che questa funzione è in grado di generare un access_token
, la configurazione è completa! Questo access_token
può ora essere usato in qualsiasi funzione successiva del Connector per tutto il tempo consentito dalle impostazioni di time-out configurate al punto 2.
Dettagli della connessione Tulip
Per consentire ai connettori di interfacciarsi con Salesforce, inserire il sottodominio dell'istanza Salesforce come "Sottodominio predefinito", nei dettagli di connessione del connettore.
Ad esempio, se l'istanza Salesforce si trova all'indirizzo sample.my.salesforce.com, il sottodominio predefinito deve essere sample.my
.
Si noti che tutte le funzioni del connettore qui riportate sono costruite per funzionare con Salesforce REST API v46.0.
Funzioni del connettore
Esistono due tipi principali di connettore: i connettori di tipo oggetto e i connettori di tipo query.
Si noti che entrambi i connettori richiedono un access_token
, quindi assicurarsi di eseguire [Auth] Get Access Token nella propria applicazione prima di questi! Di solito si consiglia di generare un nuovo token di accesso all'avvio dell'applicazione o del processo e di salvarlo in una variabile dell'applicazione per un uso successivo.
Connettori di tipo oggetto
- Restituiscono tutti i campi dell'oggetto in questione.
- Utilizzare l'endpoint
./services/data/v46.0/sobjects/<Nome oggetto>/<ID oggetto>
. - Esempio: Connettore [Opportunità] Ottieni tutti i campi
Connettori di tipo Query
- Restituisce solo i campi specificati nella query.
- Può restituire informazioni collegate (ad esempio, il nome del conto relativo a un'opportunità) o aggregate (ad esempio, il conteggio dei record).
- Utilizzare l'endpoint
./services/data/v46.0/query
- Richiede la scrittura di una query utilizzando SOQL (documentazione here{target=
_blank
}). - Esempio: Connettore [Ordine] Ottieni tutti gli ordini di stato
Funzioni del connettore incluse
Le seguenti funzioni del connettore sono incluse in questo pacchetto e servono come introduzione alle funzioni possibili tramite l'API di Salesforce: * [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Usato solo per la prima configurazione. Vedere sopra per ulteriori informazioni.* [Auth] Get Access Token * Utilizzato per generare un token di accesso, che deve essere incluso in tutte le successive funzioni del connettore.* Funzioni [Opportunity]:
* Get All Fields * Restituisce tutti i campi dell'opportunità interrogata. Richiede il Token di accesso e l'ID dell'opportunità.* Change Stage * Aggiorna lo Stage dell'opportunità indicata al valore specificato.* Funzioni [Order]: * Get All Orders of Status * Restituisce un elenco di tutti gli ordini di uno stato specificato.* Count Orders of Status * Restituisce un conteggio di tutti gli ordini di uno stato specificato.* Get Order Number from ID * Restituisce un numero di ordine da un ID ordine specificato.
Per modificare queste funzioni in base alle vostre esigenze, osservate i consigli riportati di seguito:
- Per modificare le funzioni del connettore di tipo oggetto, è sufficiente cambiare l'oggetto indicato nell'URL. Aggiungete o rimuovete nuove uscite, se necessario. 2. Per modificare le funzioni del connettore di tipo query, tutte le modifiche devono essere apportate alla query. Questa si trova nei Parametri della query, con la chiave
q
. - Suggerimento: limitare il numero di risposte di una query con la funzione LIMIT(numero_di_risposte).
Avete trovato quello che cercavate?
Potete anche andare su community.tulip.co per postare la vostra domanda o vedere se altri hanno affrontato una domanda simile!