- Nyomtat
::: (info) () Az alkalmazás letöltéséhez látogasson el a következő weboldalra: Könyvtár:::
Bevezetés
A Salesforce egy felhőalapú CRM szoftverplatform, amelyet az értékesítési leadek nyomon követésétől a rendelés- és készletkezelésig terjedő alkalmazásokban használnak.
Cél
Ez a dokumentum a Tulip Libraryben található Salesforce REST API csatlakozót részletezi. A konfigurálást követően ezek a csatlakozófunkciók a Salesforce-adatok lekérdezésére, lekérdezésére és módosítására használhatók egy Tulip alkalmazásból.
API dokumentáció
A Salesforce REST API dokumentációja itt található. Vegye figyelembe, hogy néhány, ebben a cikkben szereplő Connector Functions a SOQL (Salesforce Object Query Language) használatával hajt végre lekérdezéseket, amelynek teljes szintaxisát itt dokumentálja.
:::(Info) (API-változatok) Megjegyzés: A Salesforce számos API-t támogat különböző módszereken keresztül, amelyek teljes listája itt található.
Ez a cikk és a hozzá tartozó csatlakozók a Salesforce REST API használatára készültek.
:::
Első beállítás
:::(Warning) (Jogosultságokra figyelmeztetés) Figyelmeztetés: Az alábbi értékek generálása fejlesztői vagy rendszergazdai szintű jogosultságokat igényel a Salesforce-ban. ::: A Salesforce API hitelesítés az OAuth 2.0 szabványokat követi. Az alábbi folyamat bemutatja, hogyan kell létrehozni egy frissítési tokent, amelyet aztán bármelyik Tulip alkalmazás használ a Salesforce-hoz való sikeres csatlakozáshoz szükséges hozzáférési token lekéréséhez.
- Hozzon létre egy csatlakoztatott alkalmazást a Salesforce-ban. Ehhez navigáljon a Salesforce "Beállítás" terére. Ezután navigáljon a PLATFORM TOOLS >> Apps >> Connected Apps >> Manage Connected Apps menüpontba.
- Hozzon létre egy új csatlakoztatott alkalmazást. Tartalmazza a következőket:
a. az alkalmazás által megkövetelt minden hatókör, de mindenképpen tartalmazza arefresh_token-t
. b. Válassza az OAuth-beállítások engedélyezése lehetőséget, és adja meg a visszahívási URL-t ahttps://login.salesforce.com/services/oauth2/success
címen.
- Ha elkészült, kattintson a Fogyasztói adatok kezelése gombra, hogy láthassa a "Fogyasztói kulcsot" és a "Fogyasztói titkot". Ezeket a későbbiekben fogjuk használni.
- Most a Tulipban nyissa meg a Connector Function [Setup] Get Auth Code URL-t. Másolja ki és illessze be a fenti 3. lépésben generált "Fogyasztói kulcsot" a lekérdezési paraméter
client_id-ként
. - "Futtassa" a csatlakozófüggvényt.
- Figyelje meg, hogy a csatlakozó "kimenetként" egy URL-t generált. Illessze be ezt az URL-t a böngésző ablakába.
- Töltse ki a megjelenő hitelesítési kérdőívet, hogy sikeresen engedélyezze a Tulip számára a Salesforce-példányával való interakciót.
- Ha sikeres, a böngészőjének át kell irányítania egy új oldalra, amelyen a
Távoli hozzáférés alkalmazásengedélyezés
felirat szerepel. Az engedélyezési kódot az oldal URL-címében találja.
Például ahttps://login.salesforce.com/services/oauth2/success?code=asdf1234
URL-címben az Engedélyezési kódasdf1234
. - Mentse el ezt az engedélyezési kódot. Vegye figyelembe, hogy a kódnak két egyenlőségjelre kell végződnie:
==
. Ha a kód%3D%3D
-re végződik, távolítsa el ezeket a karaktereket, és helyettesítse==
-vel. - Navigáljon a [Setup] Get Refresh Token Tulip Connector funkcióhoz. A lekérdezési paraméterek mezőbe illessze be a fent összegyűjtött összes információt:
grant_type=
authorization_code
redirect_uri=
https://login.salesforce.com/services/oauth2/success
client_id=
a fenti 3. lépésben megadott fogyasztói kulcs.client_secret=
a fenti 3. lépésben megadott fogyasztói titok.code=
az engedélyezési kód a fenti 9. lépésből.
- Futtassa ezt a Connector-t, és mentse el a válaszban megjelenő
refresh_token-t
. - Végül navigáljon az [Auth] Get Access Token Connector Function ( Hozzáférési token lekérdezése ) menüponthoz. Töltse ki a következő lekérdezési paramétereket:
grant_type=
authorization_code
client_id=
a fenti 3. lépésben megadott fogyasztói kulcs.client_secret=
a fenti 3. lépésben megadott fogyasztói titok.refresh_token=
a fenti 10. lépésben megadott frissítési token.
- Futtassa a csatlakozót. Vegye figyelembe, hogy a válasz tartalmaz egy
access_token-t
, amely kimenetként van leképezve. Mentse a csatlakozót a frissítési token elmentéséhez.
Ha ez a funkció képes létrehozni egy access_tokent
, a beállítás befejeződött! Ez a access_token
mostantól bármelyik későbbi csatlakozófüggvényben felhasználható, amíg a 2. lépésben konfigurált időkorlát beállítások lehetővé teszik.
Tulip kapcsolat részletei
Ahhoz, hogy a csatlakozói kapcsolódhassanak a Salesforce-hoz, adja meg a Salesforce példányának aldomainjét az "Alapértelmezett aldomain"-ként a csatlakozó csatlakozási adatai között.
Például, ha a Salesforce-példány a sample.my.salesforce.com címen található, akkor az alapértelmezett aldomainnek sample.my
-nak kell lennie.
Vegye figyelembe, hogy az összes itt található csatlakozófunkció a Salesforce REST API v46.0-val való együttműködésre készült.
Csatlakozó funkciók
A csatlakozónak két elsődleges típusa létezik: objektum típusú és lekérdezés típusú csatlakozók.
Vegye figyelembe, hogy mindkét csatlakozóhoz access_token
szükséges, ezért ezek előtt mindenképpen futtassa le a [Auth] Get Access Token-t az alkalmazásában! Általánosan ajánlott egy új Access Token generálása az alkalmazás vagy folyamat indításakor, és későbbi használatra egy App Variable-be mentése.
Objektum-típusú csatlakozók
- A kérdéses objektum összes mezőjének visszaadása.
- Használja a
./services/data/v46.0/sobjects/<Object Name>/<Object ID>
végpontot. - Példa: Minden mező lekérdezése
Lekérdezés típusú csatlakozók
- Csak a lekérdezésben megadott mezőket adja vissza.
- Visszaadhat kapcsolt (pl. egy lehetőséghez kapcsolódó számlanév) vagy összesített (pl. a rekordok száma) információkat.
- Használja a
./services/data/v46.0/query
végpontot. - A SOQL használatával történő lekérdezés megírása szükséges (dokumentáció here{target=
_blank
}). - Példa: Az összes státuszú megrendelés lekérdezése.
Tartalmazott csatlakozó funkciók
A következő csatlakozófüggvények szerepelnek ebben a csomagban, és bevezetésként szolgálnak a Salesforce API-n keresztül lehetséges funkciókhoz: * [Setup] Get Auth Code URL & [Setup] Get Refresh Token * Csak az első alkalommal történő beállításhoz használható. További információkért lásd fentebb.* [Auth] Get Access Token * Access Token generálására szolgál, amelyet minden további csatlakozófunkcióban szerepeltetnikell. * [Opportunity] funkciók:
* Get All Fields * Visszaadja a lekérdezett Opportunity összes mezőjét. Access Token és Opportunity ID szükséges.* Change Stage * A megadott Opportunity Stage-jét frissíti a megadott értékre.* [Order] functions: * Get All Orders of Status * Visszaadja a megadott státuszú összes rendelés listáját.* Count Orders of Status * Visszaadja a megadott státuszú összes rendelés számát.* Get Order Number from ID * Visszaadja a megadott rendelési azonosítóból a rendelés számát.
Ha ezeket a függvényeket saját igényeinek megfelelően szeretné módosítani, vegye figyelembe az alábbi tanácsokat:
- Az objektumtípusú csatlakozófüggvények módosításához egyszerűen módosítsa az URL-ben megadott objektumot. Adjon hozzá vagy távolítson el új kimeneteket, ha szükséges. 2. A lekérdezés-típusú csatlakozófüggvények módosításához minden módosítást a lekérdezésben kell elvégezni. Ez a lekérdezés paramétereiben található, a
q
kulcs segítségével. - Tipp: korlátozza a lekérdezésből származó válaszok számát a LIMIT(number_of_responses) függvénnyel.
Megtalálta, amit keresett?
A community.tulip.co oldalon is megteheti, hogy felteszi kérdését, vagy megnézheti, hogy mások is szembesültek-e hasonló kérdéssel!