Rozszerzenie Salesforce

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wersja: 2.0.2

uzyskiwać dostęp do danych na koncie Salesforce, wstawiać, aktualizować, pobierać i przeszukiwać dane;

Te treści zawierają informacje o konfigurowaniu i używaniu tego rozszerzenia.

Wymagania wstępne

Te treści zawierają informacje o konfigurowaniu i używaniu tego rozszerzenia. Zanim zaczniesz korzystać z rozszerzenia w ramach serwera proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:

1. Utwórz parę klucza prywatnego RSA x509 lub certyfikatu.

   Podczas konfigurowania rozszerzenia użyjesz klucza prywatnego (.key) jako danych logowania. Plik certyfikatu (.crt) będzie używany podczas tworzenia połączonej aplikacji, która zapewni rozszerzeniu dostęp do Salesforce.

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

2. Skonfiguruj połączoną aplikację.

   Połączona aplikacja Salesforce zapewni dostęp do rozszerzenia Salesforce. Zapoznaj się z instrukcjami konfigurowania aplikacji.

3. Pobierz klucz klienta dla połączonej aplikacji. Rozszerzenie będzie go używać podczas uwierzytelniania w aplikacji.

   1. W konfiguracji Salesforce w menu nawigacyjnym po lewej stronie kliknij Aplikacje > Menedżer aplikacji.
   2. Na liście znajdź utworzoną połączoną aplikację.
   3. W menu po prawej stronie w wierszu aplikacji kliknij Wyświetl.
   4. W sekcji API (Enable OAuth Settings) (API (włącz ustawienia OAuth)) znajdź Consumer Key (Klucz konsumenta) i skopiuj jego wartość w bezpieczne miejsce, aby użyć jej podczas konfigurowania rozszerzenia.

Konfigurowanie połączonej aplikacji na potrzeby dostępu przez rozszerzenie

Zanim rozszerzenie Salesforce uzyska dostęp do Salesforce, musisz utworzyć połączoną aplikację Salesforce, za pomocą której rozszerzenie będzie mogło łączyć się z Salesforce.

W Salesforce połączona aplikacja umożliwia aplikacjom zewnętrznym łączenie się z Salesforce za pomocą interfejsów API.

Konfigurowanie połączonej aplikacji

1. Zaloguj się w Salesforce.
2. W prawym górnym rogu kliknij ikonę koła zębatego, a następnie Konfiguracja.
3. W menu po lewej stronie rozwiń Aplikacje > Menedżer aplikacji.
4. Na stronie App Manager (Menedżer aplikacji) kliknij New Connected App (Nowa połączona aplikacja).
5. W sekcji Podstawowe informacje wypełnij wymagane pola. Wartości te służą do celów księgowych i nie są używane przez rozszerzenie.
6. W sekcji API (Enable OAuth Settings) (API (włącz ustawienia OAuth)) zaznacz pole wyboru Enable OAuth Settings (Włącz ustawienia OAuth).
7. Wpisz Callback URL (URL wywołania zwrotnego), mimo że nie jest on używany przez rozszerzenie. Możesz użyć http://localhost/ lub innego hosta zastępczego.
8. Zaznacz pole wyboru Użyj podpisów cyfrowych.
9. W sekcji Użyj podpisów cyfrowych kliknij Wybierz plik, aby znaleźć i przesłać wygenerowany wcześniej plik salesforce.crt.
10. W sekcji Wybrane zakresy protokołu OAuth dodaj te zakresy, aby znalazły się w sekcji Wybrane zakresy protokołu OAuth:
    • Dostęp do danych i zarządzanie nimi (API)
    • Wykonywanie żądań w Twoim imieniu w dowolnym momencie (refresh_token, offline_access)
11. Kliknij Zapisz. Jeśli wystąpią błędy, może być konieczne ponowne wygenerowanie i przesłanie pliku salesforce.crt.
12. Na stronie aplikacji kliknij Zarządzaj.
13. Na stronie Menedżera aplikacji w przypadku utworzonej przed chwilą aplikacji kliknij Edytuj zasady.
14. W sekcji Zasady OAuth kliknij menu Dozwoleni użytkownicy, a następnie Użytkownicy zatwierdzeni przez administratora są wstępnie autoryzowani.
15. Kliknij Zapisz.
16. Wróć na stronę aplikacji i w sekcji Profile (Profile) kliknij Manage Profiles (Zarządzaj profilami).

17. Na stronie Application Profile Assignment (Przypisanie profilu aplikacji) zaznacz pola wyboru profili użytkowników, którzy mogą korzystać z tej aplikacji.

    Wybierz profil odpowiadający użytkownikowi, którego nazwy użyjesz podczas konfigurowania rozszerzenia. Upewnij się też, że dostęp do tej aplikacji mają co najmniej użytkownicy z rolą administratora systemu.

    Ustawienia profilu użytkownika możesz wyświetlić w Salesforce. W obszarze Konfiguracja rozwiń Użytkownicy > Użytkownicy, znajdź użytkownika, którego będzie reprezentować rozszerzenie, a następnie znajdź jego profil w kolumnie Profil.

18. Kliknij Zapisz.

Informacje o Salesforce

Salesforce to platforma do zarządzania relacjami z klientami (CRM). System CRM pomaga firmom zrozumieć potrzeby klientów i rozwiązywać problemy dzięki lepszemu zarządzaniu informacjami o klientach i interakcjami z nimi. Wszystko to na jednej platformie, która jest zawsze dostępna na każdym komputerze i urządzeniu.

Działania

Insert

Wstaw rekordy jako typy 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>

Parametry żądania

Odpowiedź

Tablica results z wynikami operacji wstawiania.

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

update

aktualizować rekordy 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>

Parametry żądania

Odpowiedź

Tablica results zawierająca wyniki aktualizacji.

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

odnajdź

Pobieranie rekordów jako obiektów SObject według ich identyfikatorów. Zwraca wszystkie pola typu 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>

Parametry żądania

Odpowiedź

Tablica records obiektów sObject reprezentowanych jako JSON. Pamiętaj, że w JSON-ie są uwzględniane wszystkie właściwości obiektów, nawet jeśli wartość właściwości to null.

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

querySOQL

Wysyłanie zapytań do Salesforce.com za pomocą języka zapytań obiektów Salesforce (SOQL).

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

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

Parametry żądania

Odpowiedź

Wyniki zapytania.

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

lista

Wyświetlanie listy rekordów Salesforce.com. Zwraca wszystkie pola określonego typu sObject.

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

Parametry żądania

Odpowiedź

Tablica records zawierająca wymienione obiekty sObject w formacie JSON.

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

←

Usuń rekordy o określonych identyfikatorach.

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

Parametry żądania

Odpowiedź

Tablica results zawierająca wyniki operacji.

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

getAccessToken

Uzyskaj token dostępu do interfejsu Salesforce.com API. Może służyć do wysyłania zapytań do interfejsów API REST.

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

Parametry żądania

Brak.

Odpowiedź

Token dostępu w formacie JSON.

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

Odwołanie do konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użycia w proxy interfejsów API postępuj zgodnie z tymi instrukcjami.

Wspólne właściwości rozszerzeń

Dla każdego rozszerzenia dostępne są poniższe właściwości.

Właściwości tego pakietu rozszerzeń

Określ wartości tych właściwości konfiguracji, które są specyficzne dla tego rozszerzenia.