Rozszerzenie Salesforce

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wersja: 1.0.3

uzyskiwać dostęp do danych na koncie Salesforce; Wstawianie, aktualizowanie i pobieranie danych oraz wykonywanie dotyczących ich zapytań.

Ta treść zawiera informacje na temat konfigurowania tego rozszerzenia i korzystania z niego.

Wymagania wstępne

Ta treść zawiera informacje na temat konfigurowania tego rozszerzenia i korzystania z niego. Zanim użyjesz zasady ExtensionCallout, musisz użyć rozszerzenia z serwera proxy interfejsu API:

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

   Podczas konfigurowania rozszerzenia użyjesz klucza prywatnego (.key) jako danych uwierzytelniających. Pliku certyfikatu (.crt) użyjesz podczas tworzenia połączonej aplikacji, która umożliwi rozszerzeniu dostęp do Salesforce.

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

2. skonfigurować połączoną aplikację.

   Dostęp do rozszerzenia Salesforce będzie udzielona aplikacja połączona z Salesforce. Instrukcje konfigurowania aplikacji znajdziesz poniżej.

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

   1. W ustawieniach Salesforce w panelu nawigacyjnym po lewej stronie kliknij Aplikacje > Menedżer aplikacji.
   2. Na liście znajdź połączoną aplikację.
   3. W menu po prawej stronie wiersza aplikacji kliknij Wyświetl.
   4. W sekcji API (Enable OAuth Settings) (Interfejs API (Włącz ustawienia protokołu OAuth)) znajdź Klucz klienta i skopiuj jego wartość w bezpieczne miejsce do użycia podczas konfigurowania rozszerzenia.

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

Aby rozszerzenie Salesforce miało dostęp do Salesforce, musisz utworzyć połączoną aplikację, przez którą rozszerzenie będzie mogło połączyć się z Salesforce.

Podłączona aplikacja w Salesforce umożliwia zewnętrznym aplikacjom łączenie się z Salesforce przez interfejsy API.

Konfigurowanie połączonej aplikacji

1. Zaloguj się w Salesforce.
2. Kliknij ikonę koła zębatego w prawym górnym rogu, a następnie kliknij Konfiguracja.
3. W panelu nawigacyjnym po lewej stronie rozwiń Aplikacje > Menedżer aplikacji.
4. Na stronie Menedżer aplikacji kliknij Nowa połączona aplikacja.
5. W sekcji Informacje podstawowe wypełnij wymagane pola. Te wartości są używane do celów księgowych i nie są używane przez rozszerzenie.
6. W sekcji Interfejs API (włącz ustawienia OAuth) zaznacz pole wyboru Włącz ustawienia protokołu OAuth.
7. Chociaż rozszerzenie nie jest używane przez rozszerzenie, wpisz URL wywołania zwrotnego. Możesz użyć hosta http://localhost/ lub innego hosta zastępczego.
8. Zaznacz pole wyboru Używaj podpisów cyfrowych.
9. W sekcji Używaj podpisów cyfrowych kliknij Wybierz plik, aby znaleźć i przesłać wygenerowany wcześniej plik salesforce.crt.
10. W sekcji Wybrane zakresy OAuth dodaj te zakresy w sekcji Wybrane zakresy OAuth:
    • Uzyskiwanie dostępu do danych i zarządzanie nimi (api)
    • Wysyłaj żądania w Twoim imieniu w dowolnym momencie (refresh_token, offline_access)
11. Kliknij Zapisz. Jeśli wystąpiły błędy, konieczne może być ponowne wygenerowanie i przesłanie pliku salesforce.crt.
12. Na wyświetlonej stronie aplikacji kliknij Zarządzaj.
13. Na stronie nowo utworzonej aplikacji w Menedżerze aplikacji kliknij Edytuj zasady.
14. W sekcji Zasady protokołu OAuth kliknij menu Dozwoleni użytkownicy, a następnie kliknij opcję Użytkownicy zatwierdzeni przez administratorów są wstępnie autoryzowani.
15. Kliknij Zapisz.
16. Na stronie aplikacji w sekcji Profile kliknij Zarządzaj profilami.

17. Na stronie Przypisywanie profilu aplikacji zaznacz pola wyboru profili użytkowników, które mogą używać tej aplikacji.

    Pamiętaj, aby wybrać profil odpowiadający użytkownikowi, którego nazwy użytkownika użyjesz podczas konfigurowania rozszerzenia. Upewnij się też, że dostęp do tej aplikacji mają przynajmniej administratorzy systemu.

    Ustawienie profilu użytkownika możesz wyświetlić w Salesforce. W obszarze Konfiguracja rozwiń Użytkownicy > Użytkownicy, znajdź użytkownika reprezentowanego przez rozszerzenie i znajdź jego profil w kolumnie Profil.

18. Kliknij Zapisz.

Informacje o Salesforce

Salesforce to platforma do zarządzania relacjami z klientami (CRM). Zarządzanie relacjami z klientami pomaga firmom zrozumieć potrzeby klientów i rozwiązywać problemy dzięki lepszemu zarządzaniu informacjami i interakcjami klientów – a wszystko to w ramach jednej platformy, 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: [] }
  ]
}

aktualizować

Zaktualizuj rekordy w 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: [] }
  ]
}

pobierz

Pobierz rekordy jako sObjects 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 sObjects reprezentowana w formacie JSON. Pamiętaj, że w pliku JSON zawarte są wszystkie właściwości obiektów, nawet jeśli ich wartość jest równa null.

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

querySOQL

Wyślij zapytanie na Salesforce.com, używając języka zapytań dotyczących obiektów 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świetl listę 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 z określonymi identyfikatorami.

<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 interfejsu API Salesforce.com. Może być używana 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"
}

Dokumentacja konfiguracji

Skorzystaj z podanych niżej instrukcji podczas konfigurowania i wdrażania tego rozszerzenia na potrzeby serwerów proxy interfejsów API.

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

Podaj wartości następujących właściwości konfiguracji specyficznych dla tego rozszerzenia.