Harici API İstekleri | AppMaster docs

Harici API İstekleri, istek şablonları tanımlamanıza ve ardından iş süreçleri içinden herhangi bir API'ye giden çağrıları tetiklemenize olanak tanır. Bunlarla, henüz piyasada herhangi bir modül bulunmasa bile projenizi herhangi bir üçüncü taraf hizmetine bağlayabilirsiniz.

Tanım

Bağlanmak istediğiniz hizmet sağlayıcının API belgelerinde, isteğin nasıl yapılandırılması gerektiğine ilişkin belirtimlere bakın.

Yeni bir istek şablonu tanımlamak için kenar çubuğundaki "İş Mantığı" sekmesine gidin (1), "Harici API İstekleri" sekmesine geçin (2) ve "Yeni API İsteği" ni tıklayın (3).

2. Yeni isteğe bir ad ve isteğe bağlı olarak bir açıklama verin.

3. İstek HTTP yöntemini ve URL'sini seçin.

4. URL parametrelerini, sorgu parametrelerini (yalnızca GET istekleri için), başlıkları ve parametre adını (1), türünü (2) girip "Parametre Ekle"yi (3) tıklayarak isteğin gövdesini tanımlayın.

Bu parametrelerin gerçek değeri, talebin tetiklendiği iş sürecinin yürütülmesi sırasında tanımlanacaktır.

URL ve sorgu parametreleri arasındaki farkı anlamak için buradan daha fazlasını okuyun. Standartlardan bağımsız olarak, bağlanmak istediğiniz hizmet sağlayıcının API belgeleri, isteğin nasıl oluşturulacağına ilişkin en iyi bilgi kaynağıdır.

Örnek JSON'u girerek istek başlıklarını ve gövdesini de otomatik olarak doldurabilirsiniz, sistem gerekli tüm parametreleri otomatik olarak oluşturacaktır.

Her sekmeye yeni parametreler eklemeniz gerekmez. Örneğin, bazı istekler hiçbir URL parametresi, başlık veya gövde içermeyebilir.

Talebinizin nesne içermesi durumunda (örn. araba -> renk, beden vb.), iş süreçlerinizde daha sonra bu nesneleri işlemek için sanal modeller oluşturmanız gerekecektir. Bunu, parametre tipi seçicide "Model"i seçerek ve ihtiyaç duyacağınız alt öğeleri tanıtarak yapın. Nesneleri istediğiniz kadar iç içe geçirebilir (yani nesne içinde nesne) ve sanal model dizileri oluşturabilirsiniz. Otomatik doldurmayı kullandıysanız, bu işlem otomatik olarak tamamlandı.

5. "Ayarlar" sekmesinde SSL doğrulama, zaman aşımı ve hata işleme gibi istek ayarlarını değiştirin.

6. "Test Talebi"ne tıklayarak ve gerekli tüm parametreleri girerek talebi test edin. Sunucudan gelen yanıtı kontrol edin ve yanıt başlıklarını ve gövdesini otomatik olarak veya manuel olarak doldurun.

7. "Talebi Kaydet"e tıklayarak talep şablonunu kaydedin.

Kullanmak

Yeni bir istek tanımlayıp kaydettikten sonra, onu tetiklemek için İş Süreci Düzenleyicisinde yeni bir blok kullanılabilir hale gelir.

İsteğe eklemek istediğiniz tüm bileşenleri (URL ve sorgu parametreleri, başlıklar ve gövde) bu bloklar kullanılarak yapılabilecek veri modelleri olarak sağlamanız gerekecektir. Çıktıda, yanıtın biçimlendirilmiş gövdesini, başlıklarını ve yanıt durumunu çıkarabileceksiniz. Bu blokları kullanarak bu modelleri genişletebilirsiniz.

İsteğin doğru şekilde tetiklenmesi için tüm veri girişlerini bağlamanız gerekmez. Örneğin, URL parametresi olmayan bir talebiniz varsa, onun modelini oluşturup bağlamanız gerekmez.

Tanımladığınız her sanal model için, oluşturmak ve genişletmek üzere İş Süreci Düzenleyicinize 2 yeni blok eklenecektir.

izleme

Bir API isteğini her tetiklediğinizde, sistem günlüklere türünü ve adresini, istek gövdesini, yanıt HTTP durum kodunu ve yanıt gövdesini verir. Yanıt gövdesinin belirli alanları veya Günlüğe Yaz bloğunu kullanarak günlüklerdeki gecikme süresi gibi diğer bilgilerin çıktısını alabilirsiniz.