תוסף Salesforce

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

גרסה: 1.0.2

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

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

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

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

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

מידע על Salesforce

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

פעולות

insert

הוספת רשומות כסוגי 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>

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

תשובה

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

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

עדכון

לעדכן את הרשומות ב-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: [] }
  ]
}

לאחזר

מאחזרים רשומות כ-sObjects לפי המזהים שלהן. מחזירה את כל השדות מסוג 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 של sObjects שמיוצגים כ-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 שמכיל sObjects שרשומים כ-JSON.

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

del

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

<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, יש להשתמש באפשרויות הבאות.

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

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

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

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