Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Sürüm: 1.0.1
Salesforce hesabınızdaki verilere erişin. Veri ekleme, güncelleme, alma ve sorgulama.
Bu içerik, bu uzantının yapılandırılması ve kullanılması için referans sağlamaktadır.
Ön koşullar
Bu içerik, bu uzantının yapılandırılması ve kullanılması için referans sağlamaktadır. ExtensionDescription politikası aracılığıyla bir API proxy'sinden uzantıyı kullanmadan önce şunları yapmanız gerekir:
RSA x509 özel anahtar/sertifika çifti oluşturun.
Uzantıyı yapılandırırken kimlik bilgisi olarak özel anahtarı (.key) kullanacaksınız. Uzantının Salesforce'a erişmesine izin verecek bağlı bir uygulama oluştururken sertifika (.crt) dosyasını 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ğrulaması yaparken bunu kullanır.
- Salesforce kurulumunda, sol gezinme bölmesinde Uygulamalar > Uygulama Yöneticisi'ne gidin.
- Listede, oluşturduğunuz bağlı uygulamayı bulun.
- Uygulamanın bulunduğu satırda sağdaki açılır listeden Görünüm'ü tıklayın.
- API (OAuth Ayarlarını Etkinleştir) bölümünde Tüketici Anahtarı'nı bulun ve değerini, uzantıyı yapılandırırken kullanmak üzere güvenli bir yere kopyalayın.
Bağlı bir uygulamayı, uzantının erişimi için ayarlama
Salesforce uzantısının Salesforce'a erişebilmesi için önce, uzantının Salesforce'a bağlanabileceği Salesforce'a bağlı bir uygulama oluşturmanız gerekir.
Salesforce'ta bağlı 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'ta oturum açın.
- Sağ üstteki dişli simgesini ve ardından Kurulum'u tıklayın.
- Soldaki gezinme bölmesinde Uygulamalar > Uygulama Yöneticisi'ne gidin.
- App Manager sayfasında Yeni Bağlı Uygulama'yı tıklayın.
- Temel Bilgiler bölümünün altındaki zorunlu alanları doldurun. Değerler muhasebe işlemleri için kullanılır; uzantı tarafından kullanılmazlar.
- API (OAuth Settings (OAuth Ayarlarını Etkinleştir)) bölümünde, Enable OAuth Settings (OAuth Ayarlarını Etkinleştir) onay kutusunu seçin.
- Uzantı tarafından kullanılmasa da bir Callback URL (Geri Arama URL'si) girin.
http://localhost/
veya başka bir yer tutucu ana makine kullanabilirsiniz. - Dijital imza kullan onay kutusunu işaretleyin.
- Daha önce oluşturduğunuz
salesforce.crt
dosyasını bulup yüklemek için Dijital imzaları kullan seçeneğinin altında Dosya Seç'i tıklayın. - Seçili OAuth Kapsamları bölümünde, aşağıdakileri ekleyerek Seçili OAuth Kapsamları'nın altına şunları ekleyin:
- Verilerinize erişme ve verileri yönetme (api)
- İstediğiniz zaman istek gönderebilirsiniz (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ş'i 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ı kullanabilen 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ından Sistem Yöneticisi kullanıcılarının bu uygulamaya erişebildiğinden emin olun.
Salesforce'ta kullanıcının profil ayarını görüntüleyebilirsiniz. Kurulum alanında Kullanıcılar > Kullanıcılar'a giderek uzantının temsil edeceği kullanıcıyı bulun, ardından Profil sütununda bu 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üşterilerinin müşterilerinin müşteri bilgilerini ve etkileşimlerini daha iyi yöneterek ihtiyaçlarını ve sorunlarını çözüyor. Tüm bunları, her zaman tüm masaüstü veya cihazlardan erişilebilen tek bir platform üzerinden gerçekleştiriyoruz.
İş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 | Zorunlu |
---|---|---|---|---|
Sobject | Eklenecek kayıtların sObject türü. | Dize | Yok. | Evet. |
kayıt | JSON'daki 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 olması için true . |
Boole | false | Sıra |
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 | Zorunlu |
---|---|---|---|---|
results[*].id | Yeni kayıt için oluşturulan sObject Kimliği. | Dize | Yok. | Evet. |
results[*].success | Bu kayıt başarıyla eklendiyse true . |
Boole | Yok. | Evet. |
results[*].errors | Yürütme sırasında yakalanan hatalar 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 | Zorunlu |
---|---|---|---|---|
Sobject | Güncellenecek kayıtların sObject türü. | Dize | Yok. | Evet. |
kayıt | JSON'daki sObject kayıtları dizisi. Güncellenecek her kayıt, kaydın kimlik değerini içermelidir. 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 olması için true . |
Boole | false | Sıra |
Yanıt
Güncellemeden gelen 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 | Zorunlu |
---|---|---|---|---|
results[*].id | Güncellenen kayıt için oluşturulan sObject Kimliği. | Dize | Yok. | Evet. |
results[*].success | Bu kayıt başarıyla eklendiyse true . |
Boole | Yok. | Evet. |
results[*].errors | Yürütme sırasında yakalanan hatalar dizisi (varsa). | Dizi | Yok. | Evet. |
geri al
Kayıtları, kimliklerine göre sObject 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 | Zorunlu |
---|---|---|---|---|
Sobject | Alınacak kayıtların sObject türü. | Dize | Yok. | Evet. |
kimlikler | Alınacak sObject ID kayıtları dizisi. Maksimum: 1.000. | Dizi | Yok. | Evet. |
allOrNone | true , isteğin herhangi bir bölümü başarısız olursa işlemin tamamında başarısız olur. |
Boole | false | Sıra |
Yanıt
JSON olarak temsil edilen bir records
sObjects dizisi. Nesnelerin tüm özelliklerinin, özellik değeri null olsa bile JSON'a dahil edileceğini unutmayın.
{
records: [
{ sobject-json },
{ sobject-json }
]
}
querySOQL
Salesforce Object Query Language (SOQL) (Salesforce Nesne Sorgusu Dili) 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 | Zorunlu |
---|---|---|---|---|
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 | Zorunlu |
---|---|---|---|---|
totalSize | Sorgu tarafından döndürülen kayıtların sayısı. | Tamsayı | Yok. | Evet. |
kayıt | JSON'de 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ı listeleme. 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 | Zorunlu |
---|---|---|---|---|
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 | Sıra |
telafi etmek | Kayıtların listeleneceği uzaklık. | Tamsayı | 0 |
Sıra |
Yanıt
JSON olarak listelenen sObject'leri 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 | Zorunlu |
---|---|---|---|---|
Sobject | Silinecek kayıtların sObject türü. | Dize | Yok. | Evet. |
kimlikler | 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 | Zorunlu |
---|---|---|---|---|
results[*].id | Belirtilen kaydın sObject kimliği. | Dize | Yok. | Evet. |
results[*].success | İşlem kayıt için başarılı olduysa true . |
Boole | Yok. | Evet. |
results[*].errors | Yürütme sırasında yakalanan hatalar dizisi (varsa). | Dizi | Yok. | Evet. |
getAccessToken
Salesforce.com API erişim jetonu alın. REST API'leri sorgulamak için kullanılabilir.
Söz dizimi
<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>
İstek parametreleri
Yok.
Yanıt
JSON dosyasındaki 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 | Zorunlu |
---|---|---|---|---|
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ıp 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 özel aşağıdaki yapılandırma özelliklerinin değerlerini belirtin.
Özellik | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
Yetkilendirme sunucusu URL'si | Salesforce'tan yetkilendirme alınırken kullanılacak URL. Normal şartlarda 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ı almaya ilişkin Ön koşullar bölümündeki talimatlara bakın. | Yok. | Evet. |
Kimlik bilgisi | Apigee Edge konsolunda kullanırken: Daha önce Ön koşullar altında oluşturduğunuz Yönetim API'si üzerinden gönderilirken: |
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. |