Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Versi: 1.0.3
Mengakses data di akun Salesforce. Menyisipkan, memperbarui, mengambil, dan mengkueri data.
Konten ini menyediakan referensi untuk mengonfigurasi dan menggunakan ekstensi ini.
Prasyarat
Konten ini menyediakan referensi untuk mengonfigurasi dan menggunakan ekstensi ini. Sebelum menggunakan ekstensi dari proxy API menggunakan kebijakan ExtensionCallout, Anda harus:
Buat pasangan kunci pribadi/sertifikasi RSA x509.
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
Menyiapkan aplikasi yang terhubung.
Aplikasi yang terhubung ke Salesforce akan memberikan akses untuk ekstensi Salesforce. Lihat petunjuk di bawah untuk menyiapkan aplikasi.
Mendapatkan kunci konsumen untuk aplikasi yang terhubung. Ekstensi akan menggunakannya saat mengautentikasi dengan aplikasi.
- Pada penyiapan Salesforce, di navigasi kiri, buka Aplikasi > App Manager.
- Dalam daftar, cari aplikasi terhubung yang Anda buat.
- Dari dropdown di sebelah kanan baris aplikasi, klik View.
- Di bagian API (Aktifkan Setelan OAuth), cari Kunci Konsumen, lalu salin nilainya ke tempat yang aman untuk digunakan saat mengonfigurasi ekstensi.
Menyiapkan aplikasi yang terhubung untuk diakses oleh ekstensi
Sebelum ekstensi Salesforce dapat mengakses Salesforce, Anda harus membuat aplikasi yang terhubung ke Salesforce yang dapat digunakan ekstensi untuk terhubung dengan Salesforce.
Di Salesforce, aplikasi yang terhubung memberikan cara bagi aplikasi eksternal untuk terhubung ke Salesforce melalui API.
Untuk menyiapkan aplikasi yang terhubung
- Login ke Salesforce.
- Klik ikon roda gigi di kanan atas, lalu klik Penyiapan.
- Pada navigasi di sebelah kiri, luaskan Apps > App Manager.
- Di halaman App Manager, klik New Connected App.
- Di bagian Informasi Dasar, isi kolom wajib diisi. Nilai tersebut untuk pembukuan; mereka tidak digunakan oleh ekstensi.
- Di bagian API (Aktifkan Setelan OAuth), centang kotak Aktifkan Setelan OAuth.
- Meskipun tidak digunakan oleh ekstensi, masukkan URL Callback. Anda dapat menggunakan
http://localhost/
atau host placeholder lainnya. - Centang kotak Gunakan tanda tangan digital.
- Di bagian Gunakan tanda tangan digital, klik Pilih File untuk mencari dan mengupload
salesforce.crt
yang Anda buat sebelumnya. - Di bagian Cakupan OAuth yang Dipilih, tambahkan hal berikut agar berada di Cakupan OAuth yang Dipilih:
- Mengakses dan mengelola data Anda (api)
- Melakukan permintaan atas nama Anda kapan saja (refresh_token, offline_access)
- Klik Simpan. Jika terjadi error, Anda mungkin perlu membuat ulang dan mengupload file
salesforce.crt
. - Di halaman aplikasi yang dihasilkan, klik Manage.
- Di halaman App Manager untuk aplikasi yang baru saja dibuat, klik Edit Kebijakan.
- Di bagian Kebijakan OAuth, klik dropdown Pengguna yang Diizinkan, lalu klik Pengguna yang disetujui admin telah diberi otorisasi.
- Klik Simpan.
- Kembali ke halaman aplikasi, di bagian Profiles, klik Manage Profiles.
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 tersebut di Salesforce. Di area Penyiapan, luaskan Pengguna > Pengguna, cari pengguna yang akan diwakili oleh ekstensi, lalu temukan profilnya di kolom Profil.
Klik Simpan.
Tentang Salesforce
Salesforce adalah platform pengelolaan hubungan pelanggan (CRM). Pengelolaan Hubungan Pelanggan membantu perusahaan memahami kebutuhan pelanggan mereka dan memecahkan masalah dengan mengelola informasi dan interaksi pelanggan dengan lebih baik — semuanya di satu platform yang selalu dapat diakses dari desktop atau perangkat apa pun.
Tindakan
insert
Sisipkan record sebagai jenis sObject.
Sintaksis
<Action>insert</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"records":[ records-to-insert ],
"allOrNone": true | false
}]]></Input>
Contoh
<Action>insert</Action>
<Input><![CDATA[{
"sobject": "Account",
"records":[
{ "Name": "MyAccountName" }
],
"allOrNone": true
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
sobject | Jenis sObject kumpulan data yang akan disisipkan. | String | Tidak ada. | Ya. |
records | Array data sObject di JSON. Maksimum: 1.000. | Array | Tidak ada. | Ya. |
allOrNone | true untuk menggagalkan seluruh update jika ada bagian dari update yang gagal. |
Boolean | false | Tidak. |
Respons
Array results
dengan hasil dari operasi penyisipan.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Properti | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
results[*].id | ID sObject yang dibuat untuk data baru. | String | Tidak ada. | Ya. |
hasil[*].sukses | true jika menyisipkan rekaman tersebut berhasil. |
Boolean | Tidak ada. | Ya. |
hasil[*].errors | Array error, jika ada, yang tertangkap selama eksekusi. | Array | Tidak ada. | Ya. |
ubah
Perbarui data Salesforce.
Sintaksis
<Action>update</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"records": [ records-to-update ],
"allOrNone": true | false
}]]></Input>
Contoh
<Action>update</Action>
<Input><![CDATA[{
"sobject": "Account",
"records":[
{
"id":"0011U00000LQ76KQAT",
"Name": "MyNewAccountName"
}
],
"allOrNone": true
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
sobject | Jenis sObject kumpulan data yang akan diperbarui. | String | Tidak ada. | Ya. |
records | Array data sObject di JSON. Setiap data yang akan diperbarui harus menyertakan nilai ID data. Maksimum: 1.000. | Array | Tidak ada. | Ya. |
allOrNone | true untuk menggagalkan seluruh update jika ada bagian dari update yang gagal. |
Boolean | false | Tidak. |
Respons
Array results
yang berisi hasil dari update.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
results[*].id | ID sObject yang dibuat untuk data yang diperbarui. | String | Tidak ada. | Ya. |
hasil[*].sukses | true jika menyisipkan rekaman tersebut berhasil. |
Boolean | Tidak ada. | Ya. |
hasil[*].errors | Array error, jika ada, yang tertangkap selama eksekusi. | Array | Tidak ada. | Ya. |
ambil
Mengambil kumpulan data sebagai sObjects berdasarkan ID-nya. Menampilkan semua kolom berjenis sObject.
Sintaksis
<Action>retrieve</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"ids":[ IDs-of-records-to-retrieve ]
}]]></Input>
Contoh
<Action>retrieve</Action>
<Input><![CDATA[{
"sobject": "Account",
"ids":["0011U00000LQ76KQAT"]
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
sobject | Jenis sObject kumpulan data yang akan diambil. | String | Tidak ada. | Ya. |
ids | Array data ID sObject yang akan diambil. Maksimum: 1.000. | Array | Tidak ada. | Ya. |
allOrNone | true untuk menggagalkan seluruh operasi jika ada bagian dari permintaan yang gagal. |
Boolean | false | Tidak. |
Respons
Array records
sObjects direpresentasikan sebagai JSON. Perhatikan bahwa semua properti objek disertakan dalam JSON, meskipun nilai propertinya adalah null.
{
records: [
{ sobject-json },
{ sobject-json }
]
}
querySOQL
Buat kueri ke Salesforce.com menggunakan Bahasa Kueri Objek Salesforce (SOQL).
Sintaksis
<Action>querySOQL</Action>
<Input><![CDATA[{
"soql": soql-query-statement
}]]></Input>
Contoh
<Action>querySOQL</Action>
<Input><![CDATA[{
"soql": "SELECT Id, Name FROM Account"
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
Soql | Pernyataan SOQL untuk dikueri. | String | Tidak ada. | Ya. |
Respons
Hasil kueri.
{
totalSize: 2,
records: [
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76KQAT',
Name: 'AccountName1'
},
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76LQAT',
Name: 'AccountName2'
}
],
done: true
}
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
totalSize | Jumlah record yang ditampilkan oleh kueri. | Bilangan Bulat | Tidak ada. | Ya. |
records | Array data yang ditampilkan sebagai sObjects di JSON. Maksimum: 1.000. | Array | Tidak ada. | Ya. |
done | true jika operasi kueri selesai. |
Boolean | Tidak ada. | Ya. |
list
Mencantumkan data Salesforce.com. Menampilkan semua kolom jenis sObject yang ditentukan.
Sintaksis
<Action>list</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"limit": max-number-of-records,
"offset": record-index-at-which-to-begin-response-set
}]]></Input>
Contoh
<Action>list</Action>
<Input><![CDATA[{
"sobject": "Account",
"limit": 1000,
"offset": 0
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
sobject | Jenis sObject kumpulan data yang akan dicantumkan. | String | Tidak ada. | Ya. |
batas | Jumlah data maksimum yang akan ditampilkan. | Bilangan Bulat | 1000 | Tidak. |
offset | Offset untuk catatan yang dicantumkan. | Bilangan Bulat | 0 |
Tidak. |
Respons
Array records
yang berisi sObject yang tercantum sebagai JSON.
{
records: [
{ sobject-json },
{ sobject-json }
]
}
hps
Menghapus data dengan ID yang ditentukan.
Sintaksis
<Action>del</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"ids":[ IDs-of-records-to-retrieve ]
}]]></Input>
Contoh
<Action>del</Action>
<Input><![CDATA[{
"sobject": "Account",
"ids":["0011U00000LQ76KQAT"]
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
sobject | Jenis sObject kumpulan data yang akan dihapus. | String | Tidak ada. | Ya. |
ids | Array ID sObject untuk data yang akan dihapus. Maksimum: 1.000. | Array | Tidak ada. | Ya. |
Respons
Array results
yang berisi hasil operasi.
{
results:[
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Properti | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
results[*].id | ID sObject dari data yang ditentukan. | String | Tidak ada. | Ya. |
hasil[*].sukses | true jika operasi berhasil untuk data. |
Boolean | Tidak ada. | Ya. |
hasil[*].errors | Array error, jika ada, yang tertangkap selama eksekusi. | Array | Tidak ada. | Ya. |
getAccessToken
Mendapatkan token akses API Salesforce.com. Dapat digunakan untuk membuat kueri REST API.
Sintaksis
<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>
Parameter permintaan
Tidak ada.
Respons
Token akses di JSON.
{
"accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
"scope":"api",
"instanceUrl": "https://na85.salesforce.com",
"id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
"tokenType": "Bearer"
}
Properti | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
accessToken | Token akses. | String | Tidak ada. | Ya. |
cakupan | Cakupan tempat token memberikan akses. | String | Tidak ada. | Ya. |
instanceUrl | URL untuk instance yang digunakan oleh org Salesforce. | String | Tidak ada. | Ya. |
id | ID aplikasi yang terhubung. | String | Tidak ada. | Ya. |
tokenType | Ketik token akses. | String | Operator | Ya. |
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 | Deskripsi | Default | Wajib |
---|---|---|---|
name |
Nama yang Anda berikan pada konfigurasi ekstensi ini. | Tidak ada | Ya |
packageName |
Nama paket ekstensi seperti yang diberikan oleh Apigee Edge. | Tidak ada | Ya |
version |
Nomor versi untuk paket ekstensi tempat Anda mengonfigurasi ekstensi. | Tidak ada | Ya |
configuration |
Nilai konfigurasi khusus untuk ekstensi yang Anda tambahkan. Lihat Properti untuk paket ekstensi ini | Tidak ada | Ya |
Properti untuk paket ekstensi ini
Tentukan nilai untuk properti konfigurasi berikut yang khusus untuk ekstensi ini.
Properti | Deskripsi | Default | Wajib |
---|---|---|---|
URL server otorisasi | URL yang akan digunakan saat mendapatkan otorisasi dari Salesforce. Harga standarnya adalah https://login.salesforce.com |
Tidak ada. | Ya. |
Kunci konsumen aplikasi yang terhubung | Kunci konsumen yang diberikan oleh Salesforce untuk aplikasi terhubung yang Anda buat. Lihat petunjuk di bagian Prasyarat untuk mengambil kunci konsumen Anda. | Tidak ada. | Ya. |
Kredensial | Saat dimasukkan di konsol Apigee Edge, ini adalah isi file salesforce.key yang Anda buat pada langkah-langkah di atas. Saat dikirim melalui API pengelolaan, nilai tersebut adalah nilai berenkode base64 yang dihasilkan dari file salesforce.key. | Tidak ada. | Ya. |
Nama pengguna dari pengguna Salesforce | Nama pengguna yang terkait dengan aplikasi terhubung yang Anda buat. Ekstensi Salesforce akan menggunakan ini untuk mendapatkan otorisasi dari Salesforce. | Tidak ada. | Ya. |