إضافة Salesforce

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

الإصدار: 1.0.2

الوصول إلى البيانات في حسابك في Salesforce. إدراج البيانات وتحديثها واستردادها والاستعلام عنها

يوفّر هذا المحتوى مرجعًا لإعداد هذه الإضافة واستخدامها.

المتطلبات الأساسية

يوفّر هذا المحتوى مرجعًا لإعداد هذه الإضافة واستخدامها. قبل استخدام الإضافة من خادم وكيل لواجهة برمجة التطبيقات باستخدام سياسة ExtensionCallout، عليك إجراء ما يلي:

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. من القائمة المنسدلة على يسار صف التطبيق، انقر على عرض.
   4. ضمن واجهة برمجة التطبيقات (تفعيل إعدادات OAuth)، حدِّد موقع مفتاح العميل وانسخ قيمته إلى مكان آمن لاستخدامه عند ضبط الإضافة.

إعداد تطبيق مرتبط للوصول إليه حسب الإضافة

قبل أن تتمكّن إضافة Salesforce من الوصول إلى Salesforce، عليك إنشاء تطبيق مرتبط على Salesforce يمكن من خلاله ربط الإضافة بخدمة Salesforce.

في Salesforce، يوفّر التطبيق المرتبط طريقة للتطبيقات الخارجية لربط Salesforce من خلال واجهات برمجة التطبيقات.

لإعداد تطبيق مرتبط

1. سجِّل الدخول إلى Salesforce.
2. انقر على رمز الترس في أعلى اليسار، ثم انقر على إعداد.
3. في شريط التنقل على اليمين، وسِّع التطبيقات > مدير التطبيقات
4. في صفحة مدير التطبيقات، انقر على تطبيق مرتبط جديد.
5. ضمن المعلومات الأساسية، املأ الحقول المطلوبة. القيم هي للمحاسبة؛ فلن يتم استخدامها بواسطة الإضافة.
6. ضمن واجهة برمجة التطبيقات (تفعيل إعدادات OAuth)، ضع علامة في مربّع الاختيار تفعيل إعدادات OAuth.
7. على الرغم من عدم استخدامها بواسطة الإضافة، أدخِل عنوان URL لمعاودة الاتصال. يمكنك استخدام http://localhost/ أو مضيف عنصر نائب آخر.
8. ضَع علامة في مربّع الاختيار استخدام التوقيعات الرقمية.
9. ضمن استخدام التوقيعات الرقمية، انقر على اختيار ملف لتحديد موقع salesforce.crt الذي أنشأته سابقًا وتحميله.
10. في قسم نطاقات OAuth المحدّدة، أضِف ما يلي حتى يكون ضمن نطاقات OAuth المحدّدة:
    • الوصول إلى بياناتك وإدارتها (واجهة برمجة التطبيقات)
    • تنفيذ الطلبات نيابةً عنك في أي وقت (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: [] }
  ]
}

استرداد

استرداد السجلّات بتنسيق 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، حتى إذا كانت قيمة السمة فارغة.

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

querySOQL

يمكنك إرسال طلب بحث إلى Salesforce.com باستخدام لغة طلب كائن Salesforce (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
}

قائمة

إدراج سجلات 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

احصل على رمز الدخول إلى واجهة برمجة تطبيقات 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"
}

مرجع الإعداد

يمكنك استخدام ما يلي عند إعداد هذه الإضافة ونشرها للاستخدام في الخوادم الوكيلة لواجهة برمجة التطبيقات.

خصائص الإضافات الشائعة

السمات التالية متاحة لكل إضافة.

خصائص حزمة الإضافات هذه

حدِّد قيمًا لخصائص الضبط التالية الخاصة بهذه الإضافة.