תוסף Salesforce

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

גרסה: 1.0.3

גישה לנתונים בחשבון Salesforce. הוספה, עדכון, אחזור והרצת שאילתות על נתונים.

התוכן הזה מספק הפניה להגדרה של התוסף הזה ולשימוש בו.

דרישות מוקדמות

התוכן הזה מספק הפניה להגדרה של התוסף הזה ולשימוש בו. לפני שמשתמשים בתוסף משרת proxy של API באמצעות המדיניות בנושא יתרונות מרכזיים של תוסף, צריך:

1. יוצרים זוג מפתח/אישור פרטי RSA x509.

   עליך להשתמש במפתח הפרטי (.key) בתור פרטי כניסה במהלך הגדרת התוסף. עליך להשתמש בקובץ האישור (.crt) כשיוצרים אפליקציה מקושרת שתיתן לתוסף גישה ל-Salesforce.

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

2. מגדירים אפליקציה מקושרת.

   אפליקציה שמקושרת ל-Salesforce תספק גישה לתוסף Salesforce. בהמשך מפורטות הוראות להגדרת האפליקציה.

3. קבלת מפתח הצרכן של האפליקציה המקושרת. התוסף ישתמש בו במהלך אימות האפליקציה.

   1. בהגדרת Salesforce, עוברים אל אפליקציות > מנהל האפליקציות בתפריט הניווט הימני.
   2. מוצאים ברשימה את האפליקציה המקושרת שיצרתם.
   3. בתפריט הנפתח שבצד שמאל בשורה של האפליקציה, לוחצים על View (תצוגה).
   4. בקטע API (הפעלת הגדרות OAuth), מוצאים את מפתח הצרכן ומעתיקים את הערך שלו למקום בטוח לשימוש במהלך הגדרת התוסף.

הגדרת אפליקציה מחוברת לגישה מהתוסף

כדי שהתוסף של Salesforce יוכל לגשת ל-Salesforce, תצטרכו ליצור אפליקציה מקושרת ל-Salesforce שבאמצעותה התוסף יוכל להתחבר ל-Salesforce.

ב-Salesforce, אפליקציה מקושרת מאפשרת לאפליקציות חיצוניות להתחבר ל-Salesforce דרך ממשקי API.

כדי להגדיר אפליקציה מקושרת

1. מתחברים ל-Salesforce.
2. לוחצים על סמל גלגל השיניים בפינה השמאלית העליונה ואז לוחצים על הגדרה.
3. בתפריט הניווט שמימין, מרחיבים את אפליקציות > מנהל אפליקציות.
4. בדף מנהל האפליקציות, לוחצים על אפליקציה מחוברת חדשה.
5. בקטע מידע בסיסי, ממלאים את שדות החובה. הערכים משמשים להנהלת חשבונות. הם לא משמשים את התוסף.
6. בקטע API (הפעלת הגדרות OAuth), מסמנים את התיבה הפעלת הגדרות OAuth.
7. למרות שהתוסף לא נמצא בשימוש, יש להזין כתובת URL לקריאה חוזרת (callback). אפשר להשתמש ב-http://localhost/ או במארח placeholder אחר.
8. מסמנים את תיבת הסימון שימוש בחתימות דיגיטליות.
9. בקטע שימוש בחתימות דיגיטליות, לוחצים על בחירת קובץ כדי לאתר ולהעלות את salesforce.crt שיצרתם קודם לכן.
10. בקטע היקפי OAuth שנבחרו, מוסיפים את הפרטים הבאים כדי שהם יופיעו בקטע היקפי OAuth נבחרים:
    • גישה לנתונים שלך וניהול שלהם (API)
    • בצע בקשות בשמך בכל עת (refresh_token, offline_access)
11. לוחצים על שמירה. אם יש שגיאות, ייתכן שיהיה עליך ליצור מחדש את קובץ ה-salesforce.crt ולהעלות אותו.
12. בדף האפליקציה שמתקבל, לוחצים על ניהול.
13. בדף מנהל האפליקציות של האפליקציה שיצרתם, לוחצים על עריכת מדיניות.
14. בקטע מדיניות OAuth, לוחצים על התפריט הנפתח משתמשים מותרים ולאחר מכן על משתמשים שאושרו על ידי אדמינים מורשים מראש.
15. לוחצים על שמירה.
16. בדף האפליקציה, בקטע פרופילים, לוחצים על ניהול פרופילים.

17. בדף הקצאת פרופילים של אפליקציות, מסמנים את תיבות הסימון של הפרופילים של המשתמשים שבהם אפשר להשתמש באפליקציה.

    הקפד לבחור בפרופיל המתאים למשתמש ששם המשתמש שלו ישמש להגדרת התוסף. כמו כן, עליך לוודא שלפחות למשתמשים של מנהל מערכת יש גישה לאפליקציה הזו.

    אפשר לראות את הגדרת הפרופיל של המשתמש ב-Salesforce. בקטע הגדרה, מרחיבים את הקטע משתמשים > משתמשים, מאתרים את המשתמש שהתוסף יייצג ומאתרים את הפרופיל שלו בעמודה פרופיל.

18. לוחצים על שמירה.

מידע על Salesforce

Salesforce היא פלטפורמה לניהול קשרי לקוחות (CRM). השירות 'ניהול קשרי לקוחות' עוזר לחברות להבין את צורכי הלקוחות שלהן ולפתור בעיות באמצעות ניהול טוב יותר של נתוני הלקוחות והאינטראקציות שלהם – והכול בפלטפורמה אחת שתמיד אפשר לגשת אליה מכל מחשב או מכשיר.

פעולות

insert

מוסיפים רשומות כסוגי אובייקטים.

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

פרמטרים של בקשה

תשובה

מערך results עם תוצאות מפעולת ההוספה.

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

update

מעדכנים את הרשומות של 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>

פרמטרים של בקשה

תשובה

מערך results שמכיל תוצאות מהעדכון.

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

אחזור

אחזור רשומות כאובייקטים לפי המזהים שלהם. מחזירה את כל השדות של סוג 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>

פרמטרים של בקשה

תשובה

מערך records של אובייקטים מיוצגים כ-JSON. שימו לב שכל המאפיינים של האובייקטים נכללים ב-JSON, גם אם ערך המאפיין הוא null.

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

querySOQL

שולחים שאילתה ל-Salesforce.com באמצעות Salesforce Object Query Language (SOQL).

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

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

פרמטרים של בקשה

תשובה

תוצאות השאילתה.

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

list

הצגת רשימה של רשומות Salesforce.com. מחזירה את כל השדות של סוג 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>

פרמטרים של בקשה

תשובה

מערך records שמכיל אובייקטים רשומים כ-JSON.

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

מחיקה

מחיקת רשומות עם המזהים שצוינו.

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

פרמטרים של בקשה

תשובה

מערך results שמכיל את תוצאות הפעולה.

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

getAccessToken

קבלת אסימון גישה ל-API של Salesforce.com. אפשר להשתמש בו כדי להריץ שאילתות על ממשקי API ל-REST.

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

פרמטרים של בקשה

ללא.

תשובה

אסימון הגישה ב-JSON.

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

סימוכין לתצורה

במהלך ההגדרה והפריסה של התוסף הזה לשימוש בשרתי proxy של API, צריך להשתמש בהגדרות הבאות.

מאפיינים נפוצים של תוספים

המאפיינים הבאים קיימים בכל תוסף.

המאפיינים של חבילת התוספים הזו

מציינים ערכים למאפייני ההגדרה הבאים שספציפיים לתוסף הזה.