Blog · 18 Eylül 2023 · Steve Simpson · Entegrasyon

Apex Web Hizmeti: Web Sihirbazları İçin Yapı Taşları

Giriş:

Bu blog yazısında Salesforce’ta özel Apex web hizmetlerinin nasıl oluşturulduğuna dalacağım. Bu hizmetler, harici bir sürecin veri okumak ya da yazmak için Salesforce ile etkileşime girmesi gerektiğinde ve standart REST API yetersiz kaldığında çok önemlidir. Standart sorgulardan güncellemelere kadar karmaşıklığı giderek artan beş örnek üzerinden ilerleyeceğiz.

Diyagram: Postman'den çağrılan beş özel Apex web hizmeti örneği: kayıt listesi döndüren GET, yanıt nesnesiyle GET, parametreli GET, POST ve hatalı POST

Özel Web Hizmetlerine Genel Bakış

Özel web hizmetlerinin beş örneğini inceleyeceğiz:

Standart SObject Listesiyle GET: Standart bir SObject listesi kullanarak veri alın.

JSON Yanıtlı Sarmalayıcı: GET isteğini bir JSON yanıtıyla sararak geliştirin.

Parametre Eklemek: Daha belirli veri alımı için GET isteğine parametreler ekleyin.

Ekleme İçin POST Kullanmak: Veri eklemek için bir POST isteği uygulayın.

Hata Mesajı Döndürmek: Hata mesajlarını uygun biçimde ele alın ve döndürün.

Özel Web Hizmetlerini Uygulamak

Örnek 1: Standart SObject Listesiyle GET

Bu örnekte özel bir URI ile bir REST kaynağı tanımlıyor ve HTTP fiilini (GET) belirtiyoruz. Sınıf global olarak bildirilmelidir ve basit bir sorgu kullanarak standart hesapların bir listesini döndürüyoruz.

Apex kodu: Hesapları sorgulayan ve listeyi varsayılan serileştirmeyle döndüren GET yöntemli bir REST kaynağı

Örnek 2: JSON Yanıtlı Sarmalayıcı

İstemciye geri gönderilen veri üzerinde kontrol sahibi olmak için bir yanıt nesnesi kullanırız. SObject listesi döndürmek yerine, bir müşterinin yalnızca kimliği ve adıyla hafif bir temsilini sunan özel yanıt nesnelerinin bir listesini döndürürüz.

Apex kodu: müşterilerin bir listesini tutan bir yanıt nesnesi oluşturan bir GET yöntemi

Örnek 3: Parametre Eklemek

Belirli bir müşteri için veriye ihtiyaç duyduğunuzda parametreler vazgeçilmezdir. RestContext.params’ı okuyarak müşteri kimliğini alabilir ve veriyi filtrelemek için onu SOQL WHERE yan tümcesinde kullanabilirsiniz.

Apex kodu: istekten bir customerid parametresi okuyan ve o müşteriyi bir yanıt nesnesi içinde döndüren bir GET yöntemi

Örnek 4: Ekleme İçin POST Kullanmak

Veri yazmanız gerektiğinde bir POST yöntemi kullanılır. Bu örnekte bir yanıt nesnesi ve bir istek nesnesi oluşturuyoruz. İstek nesnesi adı olan bir müşteri alır ve isteği belirli bir sınıfa serileştirmek için JSON serileştiricisini kullanırız. Yeni bir hesap oluşturup ekledikten sonra bir başarı durumu döndürülür.

Apex kodu: istek gövdesini ayrıştıran, bir Hesap ekleyen ve bir başarı ya da hata durumu döndüren bir POST yöntemi

Örnek 5: Hata Mesajı Döndürmek

Bu örnek 4. örneğe benzer, ancak hata yönetimi içerir. Bir istisna durumunda hata yakalanır, bir listeye eklenir ve durum kodu 500’e (ya da tercih ettiğiniz herhangi bir sayıya) ayarlanır.

Apex kodu: hata mesajını ve HTTP 500 durum kodunu döndüren, hata yönetimli POST yöntemi

Sonuç

Bu örneklerle Salesforce’ta özel Apex web hizmetleri oluşturmanın temel yapı taşlarını gösterdik. Basit bir GET isteğiyle başlayıp karmaşıklığı giderek artırdık; parametreleri, POST isteklerini ve hata yönetimini ekledik.

Takipte Kalın

Okuduğunuz için teşekkürler; yakında sizinle bilgi dolu yeni maceralar paylaşmayı dört gözle bekliyorum! Burada, www.SteveTechArc.com’da ve @SteveTechArc (opens in a new tab) YouTube kanalında takipte kalın. Abone olun ve Salesforce’u ve onu diğer sistemlerle nasıl entegre edebileceğinizi daha iyi anlayın.

Entegrasyon bilgilerini mimar meslektaşlarımla ve mimarlık yolculuğundakilerle paylaşarak dünyayı değiştirmeye yardım ediyorum!

Döküm yapay zekâ yardımıyla hazırlandı

STA 1.8