افزونه Salesforce

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

نسخه: 2.0.2

دسترسی به داده‌ها در حساب Salesforce شما. داده‌ها را درج، به‌روزرسانی، بازیابی، و پُرسمان کنید.

این محتوا مرجعی برای پیکربندی و استفاده از این افزونه ارائه می‌دهد.

پیش‌نیازها

این محتوا مرجعی برای پیکربندی و استفاده از این افزونه ارائه می‌دهد. قبل‌از استفاده از افزونه از یک پراکسی API بااستفاده از خط‌مشی ExtensionCallout، باید:

1. جفت گواهینامه یا کلید خصوصی RSA x509 ایجاد کنید.

   هنگام پیکربندی افزونه، از کلید خصوصی (.key) به‌عنوان اطلاعات اعتباری استفاده خواهید کرد. هنگام ایجاد برنامه متصل که به افزونه امکان دسترسی به Salesforce را می‌دهد، از فایل گواهینامه (.crt) استفاده خواهید کرد.

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

2. برنامه متصل‌شده‌ای راه‌اندازی کنید.

   برنامه متصل Salesforce دسترسی به افزونه Salesforce را فراهم می‌کند. دستورالعمل‌های راه‌اندازی برنامه را ببینید.

3. کلید مصرف‌کننده را برای برنامه متصل دریافت کنید. افزونه هنگام اصالت‌سنجی با برنامه از این کلید استفاده خواهد کرد.

   1. در راه‌اندازی Salesforce، در پیمایش سمت راست، به برنامه‌ها > مدیر برنامه بروید.
   2. در فهرست، برنامه متصل‌شده‌ای را که ایجاد کرده‌اید پیدا کنید.
   3. از منو کرکره‌ای در سمت چپ ردیف برنامه، روی مشاهده کلیک کنید.
   4. در بخش API (فعال کردن تنظیمات OAuth)، کلید مصرف‌کننده را پیدا کنید و مقدار آن را در مکانی امن برای استفاده در زمان پیکربندی افزونه کپی کنید.

راه‌اندازی برنامه متصل برای دسترسی افزونه

قبل‌از اینکه افزونه Salesforce بتواند به Salesforce دسترسی پیدا کند، باید برنامه متصل Salesforce را ایجاد کنید که افزونه ازطریق آن بتواند به Salesforce متصل شود.

در Salesforce، برنامه متصل روشی برای برنامه‌های خارجی فراهم می‌کند تا ازطریق «میاناهای برنامه‌سازی کاربردی» به Salesforce متصل شوند.

برای راه‌اندازی برنامه متصل‌شده

1. به سیستم Salesforce وارد شوید.
2. روی نماد چرخ‌دنده در بالا سمت چپ و سپس روی راه‌اندازی کلیک کنید.
3. در پیمایش سمت راست، برنامه‌ها > مدیر برنامه را ازهم باز کنید.
4. در صفحه مدیر برنامه، روی برنامه متصل‌شده جدید کلیک کنید.
5. در بخش اطلاعات پایه، فیلدهای الزامی را پر کنید. این مقادیر برای دفترداری است و افزونه از آن‌ها استفاده نمی‌کند.
6. در بخش API (فعال کردن تنظیمات OAuth)، چارگوش فعال کردن تنظیمات OAuth را انتخاب کنید.
7. اگرچه افزونه از آن استفاده نمی‌کند، نشانی وب تماس برگشتی را وارد کنید. می‌توانید از http://localhost/ یا میزبان جای‌بان دیگری استفاده کنید.
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

درج کردن گزارش‌ها به‌عنوان انواع 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: [] }
  ]
}

بازیابی

سوابق را به‌عنوان sObject براساس شناسه‌هایشان بازیابی کنید. همه فیلدهای نوع 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 از sObject که به‌صورت JSON نشان داده می‌شود. توجه داشته باشید که همه ویژگی‌های اشیا در JSON گنجانده شده است، حتی اگر مقدار ویژگی تهی باشد.

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

querySOQL

بااستفاده از زبان پُرسمان هدف Salesforce (SOQL)، از Salesforce.com پُرسمان کنید.

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

فهرست

فهرست کردن سوابق 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 حاوی sObjectهای فهرست‌شده به‌صورت 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

دریافت کردن کد دسترسی میانای برنامه‌سازی کاربردی Salesforce.com. می‌توان از آن برای پُرسمان کردن «میاناهای برنامه‌سازی کاربردی 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"
}

مرجع پیکربندی

هنگام پیکربندی و استقرار این افزونه برای استفاده در پراکسی‌های API، از موارد زیر استفاده کنید.

دارایی‌های افزونه مشترک

ویژگی های زیر برای هر افزونه وجود دارد.

دارایی‌های این بسته افزونه

مقادیر مشخصه‌های پیکربندی زیر را که مختص این افزونه است مشخص کنید.