Konektor Salesforce

::: (info) () Aby pobrać aplikację, odwiedź: Biblioteka:::

Wprowadzenie

Salesforce to oparta na chmurze platforma oprogramowania CRM, wykorzystywana w różnych aplikacjach, od śledzenia potencjalnych klientów po zarządzanie zamówieniami i zapasami.

Cel

Niniejszy dokument zawiera szczegółowe informacje na temat konektora Salesforce REST API znajdującego się w bibliotece Tulip Library. Po skonfigurowaniu te funkcje konektora mogą być używane do pobierania, wysyłania zapytań i modyfikowania danych Salesforce z aplikacji Tulip.

Dokumentacja API

Dokumentację interfejsu API Salesforce REST można znaleźć tutaj. Należy pamiętać, że niektóre funkcje Connector zawarte w tym artykule wykonują zapytania przy użyciu SOQL (Salesforce Object Query Language), którego pełna składnia jest udokumentowana tutaj.

:::(Info) (Wariacje API) Uwaga: Salesforce obsługuje wiele interfejsów API w różnych metodach, których pełną listę można znaleźć tutaj.
Ten artykuł i konektory, z którymi jest powiązany, są zbudowane w celu korzystania z interfejsu API Salesforce REST.
:::

Konfiguracja po raz pierwszy

:::(Warning) (Ostrzeżenie o uprawnieniach) Ostrzeżenie: generowanie poniższych wartości wymaga uprawnień na poziomie programisty lub administratora w Salesforce. ::: Uwierzytelnianie API Salesforce jest zgodne ze standardami OAuth 2.0. Poniższy proces opisuje, jak wygenerować token odświeżania, który będzie następnie używany przez dowolną aplikację Tulip do pobrania tokenu dostępu potrzebnego do pomyślnego połączenia z Salesforce.

1. Utwórz połączoną aplikację w Salesforce. Aby to zrobić, przejdź do obszaru "Setup" w Salesforce. Następnie przejdź do PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps.
2. Utwórz nową połączoną aplikację. Uwzględnij:
   a. wszelkie zakresy wymagane przez aplikację, ale pamiętaj o dołączeniu refresh_token. b. Wybierz opcję Enable OAuth Settings i wprowadź adres URL wywołania zwrotnego jako https://login.salesforce.com/services/oauth2/success.
3. Po zakończeniu kliknij Manage Consumer Details, aby zobaczyć "Consumer Key" i "Consumer Secret". Będą one używane później.
4. Teraz w aplikacji Tulip otwórz funkcję Connector [Setup] Get Auth Code URL. Skopiuj i wklej "Klucz klienta" wygenerowany w kroku 3 powyżej jako parametr zapytania client_id.
5. "Uruchom" funkcję konektora.
6. Zauważ, że adres URL został wygenerowany jako "Dane wyjściowe" konektora. Wklej ten adres URL do okna przeglądarki.
7. Wypełnij wyświetlony monit uwierzytelnienia, aby pomyślnie autoryzować Tulip do interakcji z instancją Salesforce.
8. Jeśli się powiedzie, przeglądarka powinna przekierować na nową stronę z napisem Remote Access Application Authorization. Kod autoryzacji można znaleźć w adresie URL tej strony.
   Na przykład w adresie URL https://login.salesforce.com/services/oauth2/success?code=asdf1234 kod autoryzacji to asdf1234.
9. Zapisz ten kod autoryzacji. Należy pamiętać, że kod musi kończyć się dwoma znakami równości: ==. Jeśli kod kończy się %3D%3D, usuń te znaki i zastąp je ==.
10. Przejdź do funkcji [Setup] Get Refresh Token Tulip Connector. W polu Query Parameters wklej wszystkie informacje, które zostały zebrane powyżej:
    • grant_type= authorization_code
    • redirect_uri= https://login.salesforce.com/services/oauth2/success
    • client_id= klucz klienta z kroku 3 powyżej
    • client_secret= sekret klienta z kroku 3 powyżej
    • code= kod autoryzacji z kroku 9 powyżej
11. Uruchom ten konektor i zapisz refresh_token, który pojawi się w odpowiedzi.
12. Na koniec przejdź do funkcji [Auth] Get Access Token Connector. Wypełnij następujące parametry zapytania:
    • grant_type= authorization_code
    • client_id= klucz klienta z kroku 3 powyżej
    • client_secret= sekret klienta z kroku 3 powyżej
    • refresh_token= token odświeżania z kroku 10 powyżej
13. Uruchom konektor. Zwróć uwagę, że odpowiedź zawiera access_token, który jest mapowany jako dane wyjściowe. Zapisz Connector, aby zapisać Refresh Token

Gdy ta funkcja jest w stanie wygenerować access_token, konfiguracja jest zakończona! Ten access_token może być teraz używany w każdej kolejnej funkcji konektora tak długo, jak pozwalają na to ustawienia limitu czasu skonfigurowane w kroku 2.

Szczegóły połączenia Tulip

Aby umożliwić konektorom łączenie się z Salesforce, wprowadź subdomenę instancji Salesforce jako "Domyślną subdomenę" w Szczegółach połączenia konektora.
Na przykład, jeśli instancja Salesforce znajduje się pod adresem sample.my.salesforce.com, wówczas domyślną poddomeną powinna być sample.my.

Należy pamiętać, że wszystkie funkcje konektora tutaj są zbudowane do pracy z Salesforce REST API v46.0.

Funkcje konektorów

Istnieją dwa podstawowe typy konektorów: konektory typu obiektowego i konektory typu zapytań.
Należy pamiętać, że oba konektory wymagają access_token, więc należy uruchomić [Auth] Get Access Token w aplikacji przed ich użyciem! Powszechnie zaleca się wygenerowanie nowego tokenu dostępu podczas uruchamiania aplikacji lub procesu i zapisanie go w zmiennej aplikacji do późniejszego wykorzystania.

Konektory typu obiektowego

• Zwraca wszystkie pola danego obiektu.
• Użyj punktu końcowego ./services/data/v46.0/sobjects/<nazwa obiektu>/<identyfikator obiektu>.
• Przykład: Konektor [Opportunity] Get All Fields

Konektory typu zapytania

• Zwraca tylko pola określone w zapytaniu.
• Może zwracać powiązane (np. nazwa konta powiązana z szansą) lub zagregowane (np. liczba rekordów) informacje.
• Użyj punktu końcowego ./services/data/v46.0/query
• Wymaga napisania zapytania przy użyciu SOQL (dokumentacja here{target=_blank}).
• Przykład: Konektor [Zamówienie] Pobierz wszystkie zamówienia o statusie

Dołączone funkcje konektora

Następujące funkcje konektora są zawarte w tym pakiecie i mają służyć jako wprowadzenie do funkcji możliwych za pośrednictwem interfejsu API Salesforce: * [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Używane tylko do pierwszej konfiguracji. Więcej informacji znajduje się powyżej. * [Auth] Get Access Token * Służy do generowania tokenu dostępu, który musi być uwzględniony we wszystkich kolejnych funkcjach konektora.* Funkcje [Opportunity]:
* Get All Fields * Zwraca wszystkie pola szansy, której dotyczy zapytanie. Wymaga tokena dostępu i identyfikatoraszansy. * Change Stage * Aktualizuje etap wskazanej szansy do określonejwartości. Funkcje [Order]: * Get All Orders of Status * Zwraca listę wszystkich zamówieńo określonym statusie. * Count Orders of Status * Zwraca liczbę wszystkich zamówień o określonym statusie.* Get Order Number from ID * Zwraca numer zamówienia z określonego identyfikatora zamówienia.

Aby zmodyfikować te funkcje zgodnie z własnymi potrzebami, należy zapoznać się z poniższymi wskazówkami:

1. Aby zmodyfikować funkcje Connector typu obiektowego, wystarczy zmienić obiekt wskazany w adresie URL. W razie potrzeby dodaj lub usuń nowe wyjścia. 2. Aby zmodyfikować funkcje Connector typu query, wszystkie zmiany muszą zostać wprowadzone w Query. Można to znaleźć w Parametrach zapytania, z kluczem q.
2. Wskazówka: ogranicz liczbę odpowiedzi z zapytania za pomocą funkcji LIMIT(number_of_responses).

Czy znalazłeś to, czego szukałeś?

Możesz również udać się na stronę community.tulip.co, aby opublikować swoje pytanie lub sprawdzić, czy inni mieli do czynienia z podobnym pytaniem!