Ana içeriğe geç

REST Hizmetleri

Harici bir uygulamanın kimlik doğrulaması yapması, iş adımlarını okuması veya bunlar üzerinde aksiyon gerçekleştirmesi, süreçleri başlatması, olayları tetiklemesi ya da kararları değerlendirmesi gerektiğinde Emakin REST hizmetlerini kullanın.

Temel URL

Tüm altyapı uç noktaları şu adres altında sunulur:

1
http(s)://<mydomain>.emakin.com/rest/v1

Kimlik Doğrulama Modeli

Altyapı hizmeti çağrıları bir apiKeygerektirir; bu, sistem yöneticisi tarafından verilir.

Bazı uç noktalar ayrıca logonId ve logonProvider kabul eder; böylece çağrıyı yapan taraf belirli bir kullanıcı adına işlem yapabilir. Emakin'in yerleşik oturum açma sistemi kullanıldığında, logonProvider genellikle Organizationolur. Tam logonId biçim sağlayıcıya bağlıdır.

Belirteç oluşturma uç noktaları, belirteçleri her zaman kayıtlı API anahtarının kapsamı içinde döndürür.

Yaygın İstek Kalıbı

Çoğu uç nokta aynı yapıyı izler:

  • apiKey çağrıyı yapan sistemi tanımlar
  • logonId ve logonProvider gerektiğinde çalışma zamanı kullanıcı bağlamını sağlar
  • uç noktaya özgü parametreler işlemin kendisini tanımlar

Uç Nokta Kataloğu

Kimlik Doğrulama ve Belirteç Uç Noktaları

İş Listesi ve İş Adımı Uç Noktaları

Süreç ve Olay Uç Noktaları

Kural ve Komut Uç Noktaları

Doğru Uç Noktayı Seçme

Kimliği doğrulanmış tarayıcı veya API erişimi gerektiğinde belirteç uç noktalarını kullanın. Kuyrukları veya görev aksiyonlarını entegre ederken iş listesi uç noktalarını kullanın. Başka bir sistemin iş akışını başlatması veya bu konuda bildirim göndermesi gerektiğinde süreç ve olay uç noktalarını kullanın. İş mantığının uzaktan yürütülmesi gerektiğinde karar ve modül uç noktalarını kullanın.