Ekstensi Salesforce

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Versi: 2.0.2

Mengakses data di akun Salesforce Anda. Menyisipkan, memperbarui, mengambil, dan membuat kueri data.

Konten ini memberikan referensi untuk mengonfigurasi dan menggunakan ekstensi ini.

Prasyarat

Konten ini memberikan referensi untuk mengonfigurasi dan menggunakan ekstensi ini. Sebelum menggunakan ekstensi dari proxy API menggunakan kebijakan ExtensionCallout, Anda harus:

1. Buat pasangan sertifikasi atau kunci pribadi x509 RSA.

   Anda akan menggunakan kunci pribadi (.key) sebagai kredensial saat mengonfigurasi ekstensi. Anda akan menggunakan file sertifikat (.crt) saat membuat aplikasi terhubung yang akan memberikan akses ekstensi ke Salesforce.

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

2. Siapkan aplikasi yang terhubung.

   Aplikasi yang terhubung dengan Salesforce akan memberikan akses untuk ekstensi Salesforce. Lihat petunjuk untuk menyiapkan aplikasi.

3. Dapatkan kunci konsumen untuk aplikasi yang terhubung. Ekstensi akan menggunakan kunci ini saat melakukan autentikasi dengan aplikasi.

   1. Di penyiapan Salesforce, di navigasi kiri, buka Aplikasi > Pengelola Aplikasi.
   2. Dalam daftar, temukan aplikasi terhubung yang Anda buat.
   3. Dari drop-down di sebelah kanan pada baris aplikasi, klik Lihat.
   4. Di bagian API (Enable OAuth Settings), temukan Consumer Key dan salin nilainya ke tempat yang aman untuk digunakan saat mengonfigurasi ekstensi.

Menyiapkan aplikasi terhubung untuk akses oleh ekstensi

Sebelum ekstensi Salesforce dapat mengakses Salesforce, Anda harus membuat aplikasi yang terhubung di Salesforce agar ekstensi dapat terhubung dengan Salesforce.

Di Salesforce, aplikasi terhubung menyediakan cara bagi aplikasi eksternal untuk terhubung ke Salesforce melalui API.

Untuk menyiapkan aplikasi yang terhubung

1. Login ke Salesforce.
2. Klik ikon roda gigi di kanan atas, lalu klik Penyiapan.
3. Di navigasi sebelah kiri, luaskan Aplikasi > Pengelola Aplikasi.
4. Di halaman Pengelola Aplikasi, klik Aplikasi Terhubung Baru.
5. Di bagian Informasi Dasar, isi kolom yang wajib diisi. Nilai ini untuk pembukuan; tidak digunakan oleh ekstensi.
6. Di bagian API (Aktifkan Setelan OAuth), centang kotak Aktifkan Setelan OAuth.
7. Meskipun tidak digunakan oleh ekstensi, masukkan URL Callback. Anda dapat menggunakan http://localhost/ atau host placeholder lainnya.
8. Centang kotak Gunakan tanda tangan digital.
9. Di bagian Gunakan tanda tangan digital, klik Pilih File untuk menemukan dan mengupload salesforce.crt yang Anda buat sebelumnya.
10. Di bagian Cakupan OAuth yang Dipilih, tambahkan cakupan berikut agar berada di bagian Cakupan OAuth yang Dipilih:
    • Mengakses dan mengelola data (api) Anda
    • Menjalankan permintaan atas nama Anda kapan saja (refresh_token, offline_access)
11. Klik Simpan. Jika ada error, Anda mungkin perlu membuat ulang dan mengupload file salesforce.crt.
12. Di halaman aplikasi yang muncul, klik Kelola.
13. Di halaman Pengelola Aplikasi untuk aplikasi yang baru saja Anda buat, klik Edit Kebijakan.
14. Di bagian Kebijakan OAuth, klik drop-down Pengguna yang Diizinkan, lalu klik Pengguna yang disetujui admin telah diotorisasi.
15. Klik Simpan.
16. Kembali ke halaman aplikasi, di bagian Profil, klik Kelola Profil.

17. Di halaman Penetapan Profil Aplikasi, centang kotak untuk profil pengguna yang dapat menggunakan aplikasi ini.

    Pastikan untuk memilih profil yang sesuai dengan pengguna yang nama penggunanya akan Anda gunakan saat mengonfigurasi ekstensi. Pastikan juga bahwa setidaknya pengguna Administrator Sistem memiliki akses ke aplikasi ini.

    Anda dapat melihat setelan profil untuk pengguna di Salesforce. Di area Penyiapan, luaskan Pengguna > Pengguna, temukan pengguna yang akan diwakili oleh ekstensi, lalu temukan profilnya di kolom Profil.

18. Klik Simpan.

Tentang Salesforce

Salesforce adalah platform pengelolaan hubungan pelanggan (CRM). Customer Relationship Management membantu perusahaan memahami kebutuhan pelanggan dan menyelesaikan masalah dengan mengelola informasi dan interaksi pelanggan secara lebih baik — semuanya di satu platform yang selalu dapat diakses dari desktop atau perangkat apa pun.

Tindakan

insert

Menyisipkan data sebagai jenis 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>

Parameter permintaan

Respons

Array results dengan hasil dari operasi penyisipan.

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

update

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

Parameter permintaan

Respons

Array results yang berisi hasil dari pembaruan.

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

ambil

Mengambil data sebagai sObject berdasarkan ID-nya. Menampilkan semua kolom jenis 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>

Parameter permintaan

Respons

Array records sObject yang direpresentasikan sebagai JSON. Perhatikan bahwa semua properti objek disertakan dalam JSON, meskipun nilai properti adalah null.

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

querySOQL

Kueri Salesforce.com menggunakan 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>

Parameter permintaan

Respons

Hasil kueri.

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

list

Mencantumkan data Salesforce.com. Menampilkan semua kolom jenis sObject yang ditentukan.

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

Parameter permintaan

Respons

Array records yang berisi sObject yang tercantum sebagai JSON.

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

del

Menghapus data dengan ID yang ditentukan.

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

Parameter permintaan

Respons

Array results yang berisi hasil operasi.

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

getAccessToken

Dapatkan token akses API Salesforce.com. Dapat digunakan untuk membuat kueri REST API.

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

Parameter permintaan

Tidak ada.

Respons

Token akses dalam JSON.

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

Referensi Konfigurasi

Gunakan hal berikut saat Anda mengonfigurasi dan men-deploy ekstensi ini untuk digunakan di proxy API.

Properti ekstensi umum

Properti berikut ada untuk setiap ekstensi.

Properti untuk paket ekstensi ini

Tentukan nilai untuk properti konfigurasi berikut yang khusus untuk ekstensi ini.