כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
גרסה: 1.0.3
גישה לנתונים בחשבון Salesforce. הוספה, עדכון, אחזור והרצת שאילתות על נתונים.
התוכן הזה מספק הפניה להגדרה של התוסף הזה ולשימוש בו.
דרישות מוקדמות
התוכן הזה מספק הפניה להגדרה של התוסף הזה ולשימוש בו. לפני שמשתמשים בתוסף משרת proxy של API באמצעות המדיניות בנושא יתרונות מרכזיים של תוסף, צריך:
יוצרים זוג מפתח/אישור פרטי RSA x509.
עליך להשתמש במפתח הפרטי (.key) בתור פרטי כניסה במהלך הגדרת התוסף. עליך להשתמש בקובץ האישור (.crt) כשיוצרים אפליקציה מקושרת שתיתן לתוסף גישה ל-Salesforce.
openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
-
אפליקציה שמקושרת ל-Salesforce תספק גישה לתוסף Salesforce. בהמשך מפורטות הוראות להגדרת האפליקציה.
קבלת מפתח הצרכן של האפליקציה המקושרת. התוסף ישתמש בו במהלך אימות האפליקציה.
- בהגדרת Salesforce, עוברים אל אפליקציות > מנהל האפליקציות בתפריט הניווט הימני.
- מוצאים ברשימה את האפליקציה המקושרת שיצרתם.
- בתפריט הנפתח שבצד שמאל בשורה של האפליקציה, לוחצים על View (תצוגה).
- בקטע API (הפעלת הגדרות OAuth), מוצאים את מפתח הצרכן ומעתיקים את הערך שלו למקום בטוח לשימוש במהלך הגדרת התוסף.
הגדרת אפליקציה מחוברת לגישה מהתוסף
כדי שהתוסף של Salesforce יוכל לגשת ל-Salesforce, תצטרכו ליצור אפליקציה מקושרת ל-Salesforce שבאמצעותה התוסף יוכל להתחבר ל-Salesforce.
ב-Salesforce, אפליקציה מקושרת מאפשרת לאפליקציות חיצוניות להתחבר ל-Salesforce דרך ממשקי API.
כדי להגדיר אפליקציה מקושרת
- מתחברים ל-Salesforce.
- לוחצים על סמל גלגל השיניים בפינה השמאלית העליונה ואז לוחצים על הגדרה.
- בתפריט הניווט שמימין, מרחיבים את אפליקציות > מנהל אפליקציות.
- בדף מנהל האפליקציות, לוחצים על אפליקציה מחוברת חדשה.
- בקטע מידע בסיסי, ממלאים את שדות החובה. הערכים משמשים להנהלת חשבונות. הם לא משמשים את התוסף.
- בקטע API (הפעלת הגדרות OAuth), מסמנים את התיבה הפעלת הגדרות OAuth.
- למרות שהתוסף לא נמצא בשימוש, יש להזין כתובת URL לקריאה חוזרת (callback). אפשר להשתמש ב-
http://localhost/
או במארח placeholder אחר. - מסמנים את תיבת הסימון שימוש בחתימות דיגיטליות.
- בקטע שימוש בחתימות דיגיטליות, לוחצים על בחירת קובץ כדי לאתר ולהעלות את
salesforce.crt
שיצרתם קודם לכן. - בקטע היקפי OAuth שנבחרו, מוסיפים את הפרטים הבאים כדי שהם יופיעו בקטע היקפי OAuth נבחרים:
- גישה לנתונים שלך וניהול שלהם (API)
- בצע בקשות בשמך בכל עת (refresh_token, offline_access)
- לוחצים על שמירה. אם יש שגיאות, ייתכן שיהיה עליך ליצור מחדש את קובץ ה-
salesforce.crt
ולהעלות אותו. - בדף האפליקציה שמתקבל, לוחצים על ניהול.
- בדף מנהל האפליקציות של האפליקציה שיצרתם, לוחצים על עריכת מדיניות.
- בקטע מדיניות OAuth, לוחצים על התפריט הנפתח משתמשים מותרים ולאחר מכן על משתמשים שאושרו על ידי אדמינים מורשים מראש.
- לוחצים על שמירה.
- בדף האפליקציה, בקטע פרופילים, לוחצים על ניהול פרופילים.
בדף הקצאת פרופילים של אפליקציות, מסמנים את תיבות הסימון של הפרופילים של המשתמשים שבהם אפשר להשתמש באפליקציה.
הקפד לבחור בפרופיל המתאים למשתמש ששם המשתמש שלו ישמש להגדרת התוסף. כמו כן, עליך לוודא שלפחות למשתמשים של מנהל מערכת יש גישה לאפליקציה הזו.
אפשר לראות את הגדרת הפרופיל של המשתמש ב-Salesforce. בקטע הגדרה, מרחיבים את הקטע משתמשים > משתמשים, מאתרים את המשתמש שהתוסף יייצג ומאתרים את הפרופיל שלו בעמודה פרופיל.
לוחצים על שמירה.
מידע על 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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
להתייעל | סוג ה-sObject של הרשומות שצריך להוסיף. | מחרוזת | ללא. | כן. |
רשומות | מערך של רשומות sObject ב-JSON. מקסימום: 1,000. | Array | ללא. | כן. |
allOrNone | true ייכשל בעדכון כולו אם חלק כלשהו מהעדכון ייכשל. |
בוליאני | false | לא. |
תשובה
מערך results
עם תוצאות מפעולת ההוספה.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
נכס | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
results[*].id | מזהה ה-sObject שנוצר עבור הרשומה החדשה. | מחרוזת | ללא. | כן. |
תוצאות[*].הצלחה | true אם הוספת הרשומה הצליחה. |
בוליאני | ללא. | כן. |
תוצאות[*].שגיאות | מערך של שגיאות, אם יש, שזוהו במהלך הביצוע. | Array | ללא. | כן. |
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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
להתייעל | סוג ה-sObject של הרשומות שיש לעדכן. | מחרוזת | ללא. | כן. |
רשומות | מערך של רשומות sObject ב-JSON. כל רשומה שצריך לעדכן חייבת לכלול את ערך המזהה של הרשומה. מקסימום: 1,000. | Array | ללא. | כן. |
allOrNone | true ייכשל בעדכון כולו אם חלק כלשהו מהעדכון ייכשל. |
בוליאני | false | לא. |
תשובה
מערך results
שמכיל תוצאות מהעדכון.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
results[*].id | מזהה ה-sObject שנוצר עבור הרשומה המעודכנת. | מחרוזת | ללא. | כן. |
תוצאות[*].הצלחה | true אם הוספת הרשומה הצליחה. |
בוליאני | ללא. | כן. |
תוצאות[*].שגיאות | מערך של שגיאות, אם יש, שזוהו במהלך הביצוע. | Array | ללא. | כן. |
אחזור
אחזור רשומות כאובייקטים לפי המזהים שלהם. מחזירה את כל השדות של סוג 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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
להתייעל | סוג ה-sObject של הרשומות שצריך לאחזר. | מחרוזת | ללא. | כן. |
ids | מערך של רשומות של מזהי sObject שיש לאחזר. מקסימום: 1,000. | Array | ללא. | כן. |
allOrNone | true כדי להיכשל בפעולה כולה אם חלק כלשהו בבקשה ייכשל. |
בוליאני | false | לא. |
תשובה
מערך 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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
Soql | הצהרת SOQL איתה. | מחרוזת | ללא. | כן. |
תשובה
תוצאות השאילתה.
{
totalSize: 2,
records: [
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76KQAT',
Name: 'AccountName1'
},
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76LQAT',
Name: 'AccountName2'
}
],
done: true
}
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
totalSize | מספר הרשומות שהוחזרו על ידי השאילתה. | מספר שלם | ללא. | כן. |
רשומות | מערך של רשומות שהוחזרו כאובייקטים ב-JSON. מקסימום: 1,000. | Array | ללא. | כן. |
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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
להתייעל | סוג ה-sObject של הרשומות לרשימה. | מחרוזת | ללא. | כן. |
הגבלה | מספר הרשומות המקסימלי להחזרה. | מספר שלם | 1,000 | לא. |
קיזוז | קיזוז לרשומות לרשימה. | מספר שלם | 0 |
לא. |
תשובה
מערך 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>
פרמטרים של בקשה
פרמטר | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
להתייעל | סוג ה-sObject של הרשומות למחיקה. | מחרוזת | ללא. | כן. |
ids | מערך של מזהי אובייקטים עבור רשומות למחיקה. מקסימום: 1,000. | Array | ללא. | כן. |
תשובה
מערך results
שמכיל את תוצאות הפעולה.
{
results:[
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
נכס | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
results[*].id | מזהה sObject של הרשומה שצוינה. | מחרוזת | ללא. | כן. |
תוצאות[*].הצלחה | true אם הפעולה הצליחה עבור הרשומה. |
בוליאני | ללא. | כן. |
תוצאות[*].שגיאות | מערך של שגיאות, אם יש, שזוהו במהלך הביצוע. | Array | ללא. | כן. |
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"
}
נכס | התיאור | תיאור | ברירת המחדל | נדרש |
---|---|---|---|---|
accessToken | אסימון הגישה. | מחרוזת | ללא. | כן. |
היקף | היקפי הרשאות שבהם האסימון מספק גישה. | מחרוזת | ללא. | כן. |
instanceUrl | כתובת ה-URL של המכונה שבה משתמש הארגון של Salesforce. | מחרוזת | ללא. | כן. |
id | המזהה של האפליקציה המקושרת. | מחרוזת | ללא. | כן. |
tokenType | מקלידים את אסימון הגישה. | מחרוזת | פרמטרים לרשת | כן. |
סימוכין לתצורה
במהלך ההגדרה והפריסה של התוסף הזה לשימוש בשרתי proxy של API, צריך להשתמש בהגדרות הבאות.
מאפיינים נפוצים של תוספים
המאפיינים הבאים קיימים בכל תוסף.
נכס | תיאור | ברירת המחדל | נדרש |
---|---|---|---|
name |
השם שבחרת לתצורה הזו של התוסף. | ללא | כן |
packageName |
השם של חבילת התוסף כפי שהוא סופק על ידי Apigee Edge. | ללא | כן |
version |
מספר הגרסה של חבילת התוסף שממנה מגדירים את התוסף. | ללא | כן |
configuration |
ערך הגדרה ספציפי לתוסף שרוצים להוסיף. מאפיינים לחבילת תוספים זו | ללא | כן |
המאפיינים של חבילת התוספים הזו
מציינים ערכים למאפייני ההגדרה הבאים שספציפיים לתוסף הזה.
נכס | התיאור | ברירת המחדל | נדרש |
---|---|---|---|
כתובת ה-URL של שרת ההרשאות | כתובת ה-URL שבה צריך להשתמש לקבלת הרשאה מ-Salesforce. בדרך כלל מדובר ב-https://login.salesforce.com |
ללא. | כן. |
מפתח צרכן של אפליקציה מקושרת | מפתח הצרכן שסופק על ידי Salesforce לאפליקציה המקושרת שיצרתם. עליך לעיין בהוראות בקטע דרישות מוקדמות לאחזור מפתח הצרכן. | ללא. | כן. |
פרטי כניסה | כשמזינים את הערך במסוף Apigee Edge, זהו התוכן של הקובץ salesforce.key שיצרת בשלבים שלמעלה. כשהוא נשלח דרך ממשק ה-API לניהול, הוא ערך בקידוד base64 שנוצר מהקובץ salesforce.key. | ללא. | כן. |
שם המשתמש של המשתמש ב-Salesforce | שם המשתמש שמשויך לאפליקציה המקושרת שיצרתם. התוסף של Salesforce ישתמש בכתובת הזו כדי לקבל הרשאה מ-Salesforce. | ללא. | כן. |