Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Sürüm: 1.0.3
Salesforce hesabınızdaki verilere erişme. Veri ekleme, güncelleme, alma ve sorgulama.
Bu içerik, bu uzantıyı yapılandırmak ve kullanmak için referans sağlar.
Ön koşullar
Bu içerik, bu uzantıyı yapılandırmak ve kullanmak için referans sağlar. ExtensionExtension politikasını kullanarak bir API proxy'sinden uzantıyı kullanmadan önce:
RSA x509 özel anahtar/sertifika çifti oluşturun.
Uzantıyı yapılandırırken kimlik bilgileri olarak özel anahtarı (.key) kullanacaksınız. Sertifika (.crt) dosyasını, uzantının Salesforce'a erişmesine izin verecek bağlı bir uygulama oluştururken kullanırsınız.
openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
-
Salesforce'a bağlı bir uygulama, Salesforce uzantısına erişim sağlar. Uygulamayı kurmak için aşağıdaki talimatlara bakın.
Bağlı uygulamanın tüketici anahtarını alın. Uzantı, uygulamayla kimlik doğrularken bunu kullanır.
- Salesforce kurulumunda, sol gezinme menüsünde Uygulamalar > Uygulama Yöneticisi'ne gidin.
- Oluşturduğunuz bağlı uygulamayı listede bulun.
- Uygulamanın satırında sağ tarafta bulunan açılır listeden Görünüm'ü tıklayın.
- API (Enable OAuth Settings) (API (OAuth Ayarlarını Etkinleştir) bölümünde, Tüketici Anahtarı'nı bulun ve değerini uzantıyı yapılandırırken kullanılacak güvenli bir yere kopyalayın.
Bağlı bir uygulamayı uzantı ile erişim için ayarlama
Salesforce uzantısının Salesforce'a erişebilmesi için öncelikle uzantının Salesforce'a bağlanabileceği, Salesforce'a bağlı bir uygulama oluşturmanız gerekir.
Salesforce'ta bağlı bir uygulama, harici uygulamaların API'ler aracılığıyla Salesforce'a bağlanması için bir yol sağlar.
Bağlı bir uygulamayı kurmak için
- Salesforce'a giriş yapın.
- Sağ üstteki dişli simgesini ve ardından Kurulum'u tıklayın.
- Soldaki gezinme menüsünde Uygulamalar > Uygulama Yöneticisi'ni genişletin.
- Uygulama Yöneticisi sayfasında Yeni Bağlı Uygulama'yı tıklayın.
- Temel Bilgiler'in altındaki zorunlu alanları doldurun. Değerler, muhasebe işlemleri içindir; uzantı tarafından kullanılmaz.
- API (OAuth Ayarlarını Etkinleştir) altında, OAuth Ayarlarını Etkinleştir onay kutusunu işaretleyin.
- Uzantı tarafından kullanılmasa da bir Geri Arama URL'si girin.
http://localhost/
veya başka bir yer tutucu ana makine kullanabilirsiniz. - Dijital imzaları kullan onay kutusunu seçin.
- Dijital imzalar kullan'ın altında, daha önce oluşturduğunuz
salesforce.crt
dosyasını bulup yüklemek için Dosya Seç'i tıklayın. - Seçili OAuth Kapsamları bölümünde, Seçili OAuth Kapsamları altında olmaları için aşağıdakileri ekleyin:
- Verilerinize erişme ve bunları yönetme (api)
- İstediğiniz zaman sizin adınıza istek gönderme (refresh_token, offline_access)
- Kaydet'i tıklayın. Herhangi bir hata varsa
salesforce.crt
dosyasını yeniden oluşturup yüklemeniz gerekebilir. - Açılan uygulama sayfasında Yönet'i tıklayın.
- Yeni oluşturduğunuz uygulamanın App Manager sayfasında Politikaları Düzenle'yi tıklayın.
- OAuth politikaları bölümünde, İzin Verilen Kullanıcılar açılır listesini ve ardından Yönetici onaylı kullanıcılar önceden yetkilendirilmiştir'ı tıklayın.
- Kaydet'i tıklayın.
- Uygulama sayfasına dönün ve Profiller'in altında Profilleri Yönet'i tıklayın.
Application Profile Assignment (Uygulama Profili Ataması) sayfasında bu uygulamayı kullanabilecek kullanıcı profillerinin onay kutularını seçin.
Uzantıyı yapılandırırken kullanıcı adını kullanacağınız kullanıcıya karşılık gelen bir profil seçtiğinizden emin olun. Ayrıca, en az Sistem Yöneticisi kullanıcılarının bu uygulamaya erişebildiğinden emin olun.
Kullanıcının profil ayarını Salesforce'ta görüntüleyebilirsiniz. Kurulum alanında Kullanıcılar > Kullanıcılar'ı genişletin, uzantının temsil edeceği kullanıcıyı ve ardından Profil sütununda kullanıcının profilini bulun.
Kaydet'i tıklayın.
Salesforce hakkında
Salesforce, bir müşteri ilişkileri yönetimi (CRM) platformudur. Müşteri İlişkileri Yönetimi, şirketlerin müşteri bilgilerini ve etkileşimlerini daha iyi yöneterek müşterilerin ihtiyaçlarını anlamalarına ve sorunları çözmelerine yardımcı olur. Üstelik tüm bunları tek bir platformda, dilediğiniz masaüstünden veya cihazdan erişilebilir.
İşlemler
insert
Kayıtları sObject türleri olarak ekleyin.
Söz dizimi
<Action>insert</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"records":[ records-to-insert ],
"allOrNone": true | false
}]]></Input>
Örnek
<Action>insert</Action>
<Input><![CDATA[{
"sobject": "Account",
"records":[
{ "Name": "MyAccountName" }
],
"allOrNone": true
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Sobject | Eklenecek kayıtların sObject türü. | Dize | Yok. | Evet. |
records | JSON'deki sObject kayıtları dizisi. Maksimum: 1.000. | Dizi | Yok. | Evet. |
allOrNone | Güncellemenin herhangi bir bölümü başarısız olursa güncellemenin tamamında başarısız olmak için true . |
Boole | false | Hayır |
Yanıt
Ekleme işleminden sonuçları içeren bir results
dizisi.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Özellik | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
results[*].id | Yeni kayıt için oluşturulan sObject Kimliği. | Dize | Yok. | Evet. |
sonuçlar[*].başarı | Kayıt başarıyla eklendiyse true . |
Boole | Yok. | Evet. |
sonuçlar[*].errors | Yürütme sırasında yakalanan hata dizisi (varsa). | Dizi | Yok. | Evet. |
update
Salesforce kayıtlarını güncelleyin.
Söz dizimi
<Action>update</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"records": [ records-to-update ],
"allOrNone": true | false
}]]></Input>
Örnek
<Action>update</Action>
<Input><![CDATA[{
"sobject": "Account",
"records":[
{
"id":"0011U00000LQ76KQAT",
"Name": "MyNewAccountName"
}
],
"allOrNone": true
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Sobject | Güncellenecek kayıtların sObject türü. | Dize | Yok. | Evet. |
records | JSON'deki sObject kayıtları dizisi. Güncellenecek her kaydın, kaydın kimlik değerini içermesi gerekir. Maksimum: 1.000. | Dizi | Yok. | Evet. |
allOrNone | Güncellemenin herhangi bir bölümü başarısız olursa güncellemenin tamamında başarısız olmak için true . |
Boole | false | Hayır |
Yanıt
Güncellemeden elde edilen sonuçları içeren bir results
dizisi.
{
results: [
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
results[*].id | Güncellenen kayıt için oluşturulan sObject Kimliği. | Dize | Yok. | Evet. |
sonuçlar[*].başarı | Kayıt başarıyla eklendiyse true . |
Boole | Yok. | Evet. |
sonuçlar[*].errors | Yürütme sırasında yakalanan hata dizisi (varsa). | Dizi | Yok. | Evet. |
al
Kayıtları kimliklerine göre sObjects olarak alın. sObject türündeki tüm alanları döndürür.
Söz dizimi
<Action>retrieve</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"ids":[ IDs-of-records-to-retrieve ]
}]]></Input>
Örnek
<Action>retrieve</Action>
<Input><![CDATA[{
"sobject": "Account",
"ids":["0011U00000LQ76KQAT"]
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Sobject | Alınacak kayıtların sObject türü. | Dize | Yok. | Evet. |
ids | Alınacak sObject kimlikleri kayıtları dizisi. Maksimum: 1.000. | Dizi | Yok. | Evet. |
allOrNone | İsteğin herhangi bir bölümü başarısız olursa işlemin tamamında başarısız olmak için true . |
Boole | false | Hayır |
Yanıt
JSON olarak gösterilen records
sObjects dizisi. Özellik değeri null olsa bile nesnelerin tüm özelliklerinin JSON'a eklendiğini unutmayın.
{
records: [
{ sobject-json },
{ sobject-json }
]
}
querySOQL
Salesforce Nesne Sorgu Dili (SOQL) kullanarak Salesforce.com'u sorgulayın.
Söz dizimi
<Action>querySOQL</Action>
<Input><![CDATA[{
"soql": soql-query-statement
}]]></Input>
Örnek
<Action>querySOQL</Action>
<Input><![CDATA[{
"soql": "SELECT Id, Name FROM Account"
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Soql | Sorgulanacak SOQL ifadesi. | Dize | Yok. | Evet. |
Yanıt
Sorgunun sonuçları.
{
totalSize: 2,
records: [
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76KQAT',
Name: 'AccountName1'
},
{
attributes: { attributes-of-record },
Id: '0011U00000LQ76LQAT',
Name: 'AccountName2'
}
],
done: true
}
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
totalSize | Sorgu tarafından döndürülen kayıtların sayısı. | Tamsayı | Yok. | Evet. |
records | JSON'da sObjects olarak döndürülen kayıt dizisi. Maksimum: 1.000. | Dizi | Yok. | Evet. |
bitti | Sorgu işlemi tamamlandıysa true . |
Boole | Yok. | Evet. |
list
Salesforce.com kayıtlarını listeleyin. Belirtilen sObject türündeki tüm alanları döndürür.
Söz dizimi
<Action>list</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"limit": max-number-of-records,
"offset": record-index-at-which-to-begin-response-set
}]]></Input>
Örnek
<Action>list</Action>
<Input><![CDATA[{
"sobject": "Account",
"limit": 1000,
"offset": 0
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Sobject | Listelenecek kayıtların sObject türü. | Dize | Yok. | Evet. |
sınır | Döndürülecek maksimum kayıt sayısı. | Tamsayı | 1000 | Hayır |
ofset | Kayıtların listeleneceği göreli konum. | Tamsayı | 0 |
Hayır |
Yanıt
Listelenen sObject'leri JSON olarak içeren bir records
dizisi.
{
records: [
{ sobject-json },
{ sobject-json }
]
}
sil
Belirtilen kimliklere sahip kayıtları silin.
Söz dizimi
<Action>del</Action>
<Input><![CDATA[{
"sobject": records-sObject-type,
"ids":[ IDs-of-records-to-retrieve ]
}]]></Input>
Örnek
<Action>del</Action>
<Input><![CDATA[{
"sobject": "Account",
"ids":["0011U00000LQ76KQAT"]
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
Sobject | Silinecek kayıtların sObject türü. | Dize | Yok. | Evet. |
ids | Silinecek kayıtlar için sObject kimlikleri dizisi. Maksimum: 1.000. | Dizi | Yok. | Evet. |
Yanıt
İşlemin sonuçlarını içeren bir results
dizisi.
{
results:[
{ id: '0011U00000LQ76KQAT', success: true, errors: [] },
{ id: '0011U00000LQ76LQAT', success: true, errors: [] }
]
}
Özellik | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
results[*].id | Belirtilen kaydın nesne kimliği. | Dize | Yok. | Evet. |
sonuçlar[*].başarı | İşlem, kayıt için başarılıysa true . |
Boole | Yok. | Evet. |
sonuçlar[*].errors | Yürütme sırasında yakalanan hata dizisi (varsa). | Dizi | Yok. | Evet. |
getAccessToken
Salesforce.com API erişim jetonu alın. REST API'lerini sorgulamak için kullanılabilir.
Söz dizimi
<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>
İstek parametreleri
Yok.
Yanıt
JSON'daki erişim jetonu.
{
"accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
"scope":"api",
"instanceUrl": "https://na85.salesforce.com",
"id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
"tokenType": "Bearer"
}
Özellik | Açıklama | Tür | Varsayılan | Gerekli |
---|---|---|---|---|
accessToken | Erişim jetonu. | Dize | Yok. | Evet. |
kapsam | Jetonun erişim sağladığı kapsamlar. | Dize | Yok. | Evet. |
instanceUrl | Salesforce kuruluşu tarafından kullanılan örneğin URL'si. | Dize | Yok. | Evet. |
id | Bağlı uygulamanın kimliği. | Dize | Yok. | Evet. |
tokenType | Erişim jetonunu yazın. | Dize | Taşıyıcı | Evet. |
Yapılandırma Referansı
Bu uzantıyı API proxy'lerinde kullanmak üzere yapılandırırken ve dağıtırken aşağıdakileri kullanın.
Sık kullanılan uzantı özellikleri
Aşağıdaki özellikler her uzantı için mevcuttur.
Mülk | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
name |
Uzantının bu yapılandırmasını verdiğiniz ad. | Yok | Evet |
packageName |
Apigee Edge'in sağladığı uzantı paketinin adı. | Yok | Evet |
version |
Uzantıyı yapılandırdığınız uzantı paketinin sürüm numarası. | Yok | Evet |
configuration |
Eklediğiniz uzantıya özgü yapılandırma değeri. Bu uzantı paketinin özellikleri başlıklı makaleyi inceleyin | Yok | Evet |
Bu uzantı paketinin özellikleri
Bu uzantıya özgü aşağıdaki yapılandırma özellikleri için değerler belirtin.
Özellik | Açıklama | Varsayılan | Gerekli |
---|---|---|---|
Yetkilendirme sunucusu URL'si | Salesforce'tan yetkilendirme alırken kullanılacak URL. Genellikle bu süre https://login.salesforce.com |
Yok. | Evet. |
Bağlı uygulama tüketici anahtarı | Oluşturduğunuz bağlı uygulama için Salesforce tarafından sağlanan tüketici anahtarı. Tüketici anahtarınızı almayla ilgili Ön koşullar başlığı altındaki talimatlara bakın. | Yok. | Evet. |
Kimlik Bilgisi | Apigee Edge konsoluna girdiğinizde, yukarıdaki adımlarda oluşturduğunuz Salesforce.key dosyasının içeriği budur. Yönetim API'si ile gönderildiğinde, Salesforce.key dosyasından oluşturulan base64 kodlu bir değerdir. | Yok. | Evet. |
Salesforce kullanıcısının kullanıcı adı | Oluşturduğunuz bağlı uygulamayla ilişkilendirilen kullanıcı adı. Salesforce uzantısı, Salesforce'tan yetkilendirme almak için bunu kullanır. | Yok. | Evet. |