Ana içeriğe geç

REST Hizmetleri

Harici bir uygulamanın kimlik doğrulaması yapması, iş adımlarını okuması veya bunlar üzerinde işlem yapması, 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 yol altında sunulur:

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

Kimlik Doğrulama Modeli

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

Bazı uç noktalar, çağıranın belirli bir kullanıcı adına işlem yapabilmesi için logonId ve logonProvider değerlerini de kabul eder. Emakin'in yerleşik oturum açma sistemi kullanıldığında logonProvider genellikle Organizationolur. Kesin logonId biçimi 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 Yapısı

Uç noktaların çoğu aynı yapıyı izler:

  • apiKey çağıran 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 Betik Uç Noktaları

Doğru Uç Noktayı Seçme

Kimliği doğrulanmış tarayıcı veya API erişimi gerektiğinde token uç noktalarını kullanın. Kuyrukları veya görev eylemlerini entegre ederken iş listesi uç noktalarını kullanın. Başka bir sistemin iş akışını başlatması veya bu konuda bildirimde bulunması 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.