Connettore Salesforce

Introduzione

Salesforce è una piattaforma software CRM basata su cloud, utilizzata in applicazioni che spaziano dal monitoraggio dei lead di vendita alla gestione degli ordini e delle scorte.

Scopo

Il presente documento descrive in dettaglio il connettore API REST di Salesforce disponibile nella Libreria Tulip. Una volta configurate, queste funzioni del connettore possono essere utilizzate per recuperare, interrogare e modificare i dati di Salesforce da un’app Tulip.

Documentazione API

La documentazione relativa all’API REST di Salesforce è disponibile qui. Si noti che alcune funzioni del connettore incluse in questo articolo eseguono le query utilizzando SOQL (Salesforce Object Query Language), la cui sintassi completa è documentata qui.

Configurazione iniziale

L'autenticazione dell'API di Salesforce segue gli standard OAuth 2.0. La procedura seguente illustra come generare un token di aggiornamento, che verrà poi utilizzato da qualsiasi app Tulip per recuperare il token di accesso necessario per connettersi correttamente a Salesforce.

1. Creare un’app connessa in Salesforce. A tal fine, accedere all’area “Configurazione” in Salesforce. Successivamente, selezionare STRUMENTI DELLA PIATTAFORMA >> App >> App connesse >> Gestisci app connesse.
2. Creare una nuova app collegata. Includere: a. tutti gli ambiti richiesti dalla propria applicazione, assicurandosi di includere refresh_token. b. Selezionare Abilita impostazioni OAuth e inserire l’URL di callback come https://login.salesforce.com/services/oauth2/success.
3. Una volta completata l’operazione, fare clic su “Gestisci dettagli consumatore ” per visualizzare la “Chiave consumatore” e il “Segreto consumatore”. Questi saranno utilizzati in seguito.
4. Ora, in Tulip, apri l’URL [Configurazione] Ottieni codice di autenticazione dell’ Connector Function. Copia e incolla la “Chiave consumatore” generata nel passaggio 3 sopra come parametro di query client_id.
5. "Esegui" il connettore " Connector Function".
6. Noterete che è stato generato un URL come "Output" del connettore. Incollate questo URL nella finestra del browser.
7. Completa la procedura di autenticazione che appare per autorizzare correttamente Tulip a interagire con la tua istanza di Salesforce.
8. Se l’operazione va a buon fine, il browser dovrebbe reindirizzarti a una nuova pagina denominata " Autorizzazione dell’applicazione di accesso remoto". Il codice di autorizzazione è riportato nell’URL di questa pagina. Ad esempio, nell’URL https://login.salesforce.com/services/oauth2/success?code=asdf1234 il codice di autorizzazione è asdf1234.
9. Salva questo codice di autorizzazione. Tieni presente che il codice deve terminare con due simboli di uguale: ==. Se il codice termina con %3D%3D, rimuovi questi caratteri e sostituiscili con ==.
10. Accedere alla pagina [Configurazione] Ottieni token di aggiornamento di Tulip Connector Function. Nei parametri di 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 del passaggio 3 sopra
    • client_secret= il segreto del consumatore del passaggio 3 sopra
    • code= il codice di autorizzazione del passaggio 9 sopra
11. Esegui questo connettore e salva il refresh_token che appare nella risposta.
12. Infine, vai alla pagina [Auth] Ottieni token di accesso Connector Function. Compila i seguenti parametri di query:
    • grant_type= authorization_code
    • client_id= la chiave del consumatore indicata al punto 3 sopra
    • client_secret= il segreto del consumatore indicato al punto 3 sopra
    • refresh_token= il token di aggiornamento del passaggio 10 sopra
13. Esegui il connettore. Tieni presente che la risposta include un `access_token`, che viene mappato come output. Salva 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 utilizzato in qualsiasi successiva chiamata Connector Function per tutto il tempo consentito dalle impostazioni di timeout configurate nel Passo 2.

Dettagli di connessione a Tulip

Per consentire ai tuoi Connettori di interfacciarsi con Salesforce, inserisci il sottodominio della tua istanza Salesforce come "Sottodominio predefinito", nella sezione Dettagli di connessione del Connettore. Ad esempio, se l'istanza Salesforce è raggiungibile all'indirizzo sample.my.salesforce.com, il sottodominio predefinito dovrebbe essere sample.my.

Si noti che tutti i connettori " Connector Functions " qui presenti sono progettati per funzionare con l’API REST di Salesforce v46.0.

Connector Functions

Esistono due tipi principali di connettori: quelli di tipo oggetto e quelli di tipo query. Si noti che entrambi i connettori richiedono un access_token, quindi assicurarsi di eseguire [Auth] Ottieni token di accesso nella propria app prima di utilizzarli! In genere si consiglia di generare un nuovo token di accesso all’avvio dell’app o del processo e di salvarlo in una variabile dell’app 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 [Opportunity] Ottieni tutti i campi

Connettori di tipo query

• Restituiscono solo i campi specificati nella query.
• Possono restituire informazioni collegate (ad es. il nome dell’account associato a un’opportunità) o aggregate (ad es. il numero di record).
• Utilizza l'endpoint ./services/data/v46.0/query
• È necessario scrivere una query utilizzando SOQL (documentazione qui{target=_blank}).
• Esempio: Connettore [Ordine] Ottieni tutti gli ordini con stato

Inclusi Connector Functions

I seguenti Connector Functions sono inclusi in questo pacchetto e hanno lo scopo di fungere da introduzione alle funzioni disponibili tramite l’API di Salesforce:* [Setup] Ottieni URL del codice di autenticazione e [Setup] Ottieni token di aggiornamento * Utilizzati solo per la configurazione iniziale. Vedi sopra per ulteriori informazioni.*[Auth] Ottieni token di accesso * Utilizzato per generare un token di accesso, che deve essere incluso in tutte le successive chiamate all’ Connector Functions.* Funzioni [Opportunity]: * Ottieni tutti i campi * Restituisce tutti i campi dell’opportunità interrogata. Richiede il token di accesso e l’ID dell’opportunità. * Modifica fase * Aggiorna la fase dell’opportunità indicata al valore specificato.* Funzioni [Order]: * Ottieni tutti gli ordini con stato * Restituisce un elenco di tutti gli ordini con uno stato specificato. * Conta gli ordini con stato * Restituisce il numero totale di ordini con uno stato specificato. * Ottieni il numero d’ordine dall’ID * Restituisce il numero d’ordine a partire da un ID ordine specificato.

Per modificare queste funzioni in base alle proprie esigenze, tenere presente quanto segue: 1. Per modificare le funzioni di tipo oggetto Connector Functions, è sufficiente cambiare l’oggetto indicato nell’URL. Aggiungi o rimuovi nuovi output secondo necessità. 2. Per modificare le funzioni di tipo query Connector Functions, tutte le modifiche devono essere apportate nella query. Questa si trova nei parametri della query, con la chiave q. 1. Suggerimento: limita il numero di risposte da una query con la funzione LIMIT(numero_di_risposte)

Hai trovato quello che cercavi?

Puoi anche visitare community.tulip.co per pubblicare la tua domanda o vedere se altri hanno affrontato un problema simile!