Estensione Salesforce

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

Versione: 1.0.5

Accedere ai dati nel tuo account Salesforce. Inserire, aggiornare, recuperare e eseguire query sui dati.

Questi contenuti forniscono un riferimento per la configurazione e l'utilizzo di questa estensione.

Prerequisiti

Questi contenuti forniscono un riferimento per la configurazione e l'utilizzo di questa estensione. Prima di utilizzare l'estensione da un proxy API utilizzando il criterio ExtensionCallout, devi:

1. Crea una coppia di certificazione/chiave privata RSA x509.

   Utilizzerai la chiave privata (.key) come credenziali durante la configurazione dell'estensione. Utilizzerai il file del certificato (.crt) quando crei un'app collegata che concederà all'estensione l'accesso a Salesforce.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Configura un'app collegata.

   Un'app collegata a Salesforce fornirà l'accesso per l'estensione Salesforce. Segui le istruzioni riportate di seguito per configurare l'app.

3. Recupera la chiave consumer per l'app collegata. L'estensione la utilizzerà per l'autenticazione con l'app.

   1. Nella configurazione di Salesforce, nel riquadro di navigazione a sinistra, vai a App > Gestore app.
   2. Nell'elenco, individua l'app collegata che hai creato.
   3. Nel menu a discesa a destra nella riga dell'applicazione, fai clic su Visualizza.
   4. In API (Attiva impostazioni OAuth), individua la chiave consumer e copia il relativo valore in un luogo sicuro per utilizzarlo durante la configurazione dell'estensione.

Configurare un'app collegata per l'accesso da parte dell'estensione

Prima che l'estensione Salesforce possa accedere a Salesforce, devi creare un'app collegata a Salesforce tramite la quale l'estensione possa connettersi a Salesforce.

In Salesforce, un'app collegata consente alle applicazioni esterne di connettersi a Salesforce tramite API.

Per configurare un'app collegata

1. Accedi a Salesforce.
2. Fai clic sull'icona a forma di ingranaggio in alto a destra e poi su Configurazione.
3. Nel riquadro di navigazione a sinistra, espandi App > Gestore app.
4. Nella pagina Gestione app, fai clic su Nuova app collegata.
5. In Informazioni di base, compila i campi obbligatori. I valori sono per la contabilità e non vengono utilizzati dall'estensione.
6. In API (Attiva impostazioni OAuth), seleziona la casella di controllo Attiva impostazioni OAuth.
7. Anche se non viene utilizzato dall'estensione, inserisci un URL di callback. Puoi utilizzare http://localhost/ o un altro host segnaposto.
8. Seleziona la casella di controllo Utilizza firme digitali.
9. In Utilizza le firme digitali, fai clic su Scegli file per individuare e caricare il file salesforce.crt generato in precedenza.
10. Nella sezione Ambiti OAuth selezionati, aggiungi quanto segue in modo che siano inclusi in Ambiti OAuth selezionati:
    • Accedere ai dati e gestirli (API)
    • Eseguire richieste per tuo conto in qualsiasi momento (refresh_token, offline_access)
11. Fai clic su Salva. In caso di errori, potrebbe essere necessario rigenerare e ricaricare il file salesforce.crt.
12. Nella pagina dell'app visualizzata, fai clic su Gestisci.
13. Nella pagina Gestione app dell'app appena creata, fai clic su Modifica criteri.
14. In Criteri OAuth, fai clic sul menu a discesa Utenti consentiti e poi su Gli utenti approvati dall'amministratore sono preautorizzati.
15. Fai clic su Salva.
16. Torna alla pagina dell'app e fai clic su Gestisci profili in Profili.

17. Nella pagina Assegnazione profilo dell'applicazione, seleziona le caselle di controllo per i profili utente che possono utilizzare questa applicazione.

    Assicurati di selezionare un profilo corrispondente all'utente di cui utilizzerai il nome utente durante la configurazione dell'estensione. Assicurati inoltre che almeno gli utenti Amministratore di sistema abbiano accesso a questa applicazione.

    Puoi visualizzare l'impostazione del profilo dell'utente in Salesforce. Nell'area Configurazione, espandi Utenti > Utenti, individua l'utente che l'estensione rappresenterà e poi il suo profilo nella colonna Profilo.

18. Fai clic su Salva.

Informazioni su Salesforce

Salesforce è una piattaforma di gestione dei rapporti con i clienti (CRM). Il Customer Relationship Management aiuta le aziende a comprendere le esigenze dei clienti e a risolvere i problemi gestendo meglio le informazioni e le interazioni con i clienti, il tutto su un'unica piattaforma sempre accessibile da qualsiasi computer o dispositivo.

Azioni

insert

Inserisci i record come tipi di sObject.

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Parametri di richiesta

Risposta

Un array results con i risultati dell'operazione di inserimento.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

Aggiorna i record Salesforce.

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Parametri di richiesta

Risposta

Un array results contenente i risultati dell'aggiornamento.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

retrieve

Recupera i record come sObjects in base ai relativi ID. Restituisce tutti i campi del tipo sObject.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parametri di richiesta

Risposta

Un array records di sObjects rappresentati come JSON. Tieni presente che tutte le proprietà degli oggetti sono incluse nel JSON, anche se il valore della proprietà è nullo.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

Esegui query su Salesforce.com utilizzando il linguaggio SOQL (Salesforce Object Query Language).

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Parametri di richiesta

Risposta

Risultati della query.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

Elenca i record di Salesforce.com. Restituisce tutti i campi del tipo sObject specificato.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Parametri di richiesta

Risposta

Un array records contenente sObjects elencati come JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

ce

Elimina i record con gli ID specificati.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parametri di richiesta

Risposta

Un array results contenente i risultati dell'operazione.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

Ottieni il token di accesso all'API Salesforce.com. Può essere utilizzato per eseguire query sulle API REST.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Parametri di richiesta

Nessuno.

Risposta

Il token di accesso in JSON.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Riferimento alla configurazione

Utilizza quanto segue quando configuri ed esegui il deployment di questa estensione per utilizzarla nei proxy API.

Proprietà comuni delle estensioni

Per ogni estensione sono presenti le seguenti proprietà.

Proprietà per questo pacchetto di estensioni

Specifica i valori per le seguenti proprietà di configurazione specifiche di questa estensione.