Sözleşmeler/Protokoller
Bazı durumlarda istemcilerin kullanımına sunulacak servislerin bir sözleşme/protokol yapılarak açılması ve/veya kullanılması söz konusu olabilir. Bu gibi durumlarda sözleşme/protokol metninin geçmişiyle beraber tutulması, hangi servislerin ve kimlik bilgilerinin bu sözleşme/protokol ile ilişkili olduğunun bilinmesi gerekli olabilir.
Sözleşmeler/Protokoller sayfasına ilk girildiğinde aşağıdaki görselde görüldüğü gibi mevcut tüm sözleşme/protokol kayıtları listelenir:
Yeni bir sözleşme/protokol oluşturmak için sağ üst köşedeki Oluştur (Create) tuşuna basılır ve aşağıdaki görselde yer alan bilgiler kaydedilerek sözleşme/protokol kaydı tamamlanır.
Ya da mevcut sözleşme/protokolden ayalarının baz alındığı yeni bir sözleşme/protokol oluşturmak için kaydın detay menüsündeki Add a Contract (Yeni Sözleşme/Protokol Ekle) seçeneğine tıklanır.
Sözleşme/Protokol ayarlarını içeren görsele aşağıda yer verilmiştir:
Sözleşme/protokol konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
| Alan | Açıklama |
|---|---|
| İsim | Sözleşmeye/protokole verilen isimdir. |
| Açıklama | Sözleşmenin/protokolün ne içerdiğini tarif etmek için isteğe bağlı olarak açıklama bilgisi girilebilir. |
| Yön (Direction) | Sözleşme konusu servislerin (API Proxylerin) kullanım tipini ifade eder. Bu alanı değerlendirirken Apinizer'a sahip olan kurumun ilgili servisler ile alakası göz önüne alınmalıdır. Eğer kurum servisi oluşturmuş ise Üretici (Publisher), kurum var olan bir servisi iç uygulamalarının kullanımına açıyor ise Tüketici (Consumer), ikisinin de söz konusu olması durumunda Üretici ve Tüketici (Publisher and Consumer) seçeneği seçilebilir. Eğer herhangi biri seçilmek istenmiyorsa Belirtilmemiş (Unspecified) ifadesi kullanılmalıdır. |
| Başlangıç Zamanı (Start Date) | Sözleşmenin başlangıç zamanı bilgisidir. |
| Bitiş Zamanı (End Date) | Sözleşmenin bitiş zamanı bilgisidir. |
| Kimlik Bilgilerinin son kullanımı için Bitiş Tarihini kullan (Use End Date for Credentials) | Bu seçenek aktif hale getirildiğinde sözleşme/protokol ile ilişkilendirilmiş kimlik bilgilerinin kullanım izni sözleşme süresinin dolmasıyla birlikte otomatik dolar ve yeni istek yapamaz hale gelirler. Tabii bu ayarın geçerli olması için ilişkili API Proxy üzerinde kimlik doğrulama politikalarından birisi eklenmiş olmalı ve bu politikada kimlik doğrulama şekli olarak Security Manager seçeneği seçili olmalıdır. |
| API Proxy'lerin son kullanımı için Bitiş Tarihini kullan (Stop Access on End Date of Contract for API Proxies) | Bu seçenek aktif hale getirildiğinde sözleşme/protokol ile ilişkilendirilmiş API Proxy kullanım izni sözleşme süresinin dolmasıyla birlikte otomatik dolar ve yeni istek yapamaz hale gelirler. Tabii bu ayarın geçerli olması için ilişkili API Proxy üzerinde kimlik doğrulama politikalarından birisi eklenmiş olmalı ve bu politikada kimlik doğrulama şekli olarak Security Manager seçeneği seçili olmalıdır. |
| Durum (Status) | Sözleşmenin aktif mi, pasif mi olduğu bilgisidir. |
| Kurum (Organization) | Sözleşmenin hangi kurum ile yapıldığı bilgisidir. |
Dosyalar (Files) Sekmesi
Sözleşme/protokol ile ilişkili dokümanların, sözleşme/protokol kaydı içerisinde yer alması isteniyorsa, yukarıdaki görselde kırmızı ile işaretli Ekle (Add) tuşuna basılır ve aşağıdaki görselde yer alan gerekli bilgiler girilerek dosya sözleşmeye/protokole kaydedilir.
Dosya konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
| Alan | Açıklama |
|---|---|
| Durum (Status) | Dosyanın durumunu ifade eder. |
| Açıklama | Dosya içeriği hakkında açıklama girilmek istenirse bu alan kullanılabilir. |
| Dosya (Select File) | Yüklenmek istenen dosyadır |
API Proxy'ler Sekmesi
Sözleşme/protokol ile ilişkili API Proxy'lerin, sözleşme/protokol kaydı içerisinde yer alması isteniyorsa, aşağıdaki görselde kırmızı ile işaretli Ekle (Add) tuşuna basılır.
Ekle tuşuna basıldığında proje içerisinde yer alan API Proxy'ler aşağıdaki görseldeki gibi listelenir.
Sözleşme ile ilişkisi kurulmak istenen API proxy'ler bu listeden seçilerek kaydedilir.
Kimlik Bilgisi (Credentials) Sekmesi
Sözleşme/protokol ile ilişkili kimlik bilgilerinin, sözleşme/protokol kaydı içerisinde yer alması isteniyorsa, aşağıdaki görselde kırmızı ile işaretli Ekle (Add) tuşuna basılır.
Ekle tuşuna basıldığında proje içerisinde yer alan veya globalde tanımlanmış olan kimlik bilgisi listesi aşağıdaki görseldeki gibi listelenir.
Sözleşme ile ilişkisi kurulmak istenen kimlik bilgileri bu listeden seçilerek kaydedilir.
Eğer istenen kimlik bilgisi bu listede yer almıyorsa Oluştur (Create) tuşuna basılarak yeni kimlik bilgisi oluşturulabilir.
Kimlik bilgisi ekranı ile ilgili daha detaylı bilgi için Kimlik Bilgisi Yönetimi sayfasını ziyaret edebilirsiniz.
Önerilen Erişim İzinleri (Recommended Access)
Bir API Proxy'yi veya Kimlik Bilgisini API Proxy'ler ya da Kimlik Bilgisi sekmesine eklemek tek başına erişim izni (ACL) vermez; bu işlem yalnızca kaydı sözleşme/protokol ile ilişkilendirir.
Sözleşmeye/protokole eklenmiş olup ilgili API Proxy'nin ACL'inde henüz yer almayan kimlik bilgileri varsa, API Proxy'ler sekmesindeki satırda bir uyarı simgesi görüntülenir. Aynı şekilde, sözleşmeye eklenmiş olup bir kimlik bilgisinin ACL'inde henüz yer almayan API Proxy'ler varsa Kimlik Bilgisi sekmesindeki satırda uyarı simgesi görüntülenir.
Uyarı simgesine tıklandığında yalnızca henüz erişim izni verilmemiş kimlik bilgileri/API Proxy'ler listelenir; buradan seçilip kaydedilen kayıtlar için erişim izni (ACL) verilir.
Bu şekilde sözleşme üzerinden verilen erişim izinleri, API Proxy ACL sayfasında açıklanan tekillik kuralına tabidir ve manuel olarak verilen izinler gibi ACL geçmişine kaydedilir. Zaten yetkili bir kayıt için (ör. eşzamanlı oturumlarda) tekrar erişim verilmeye çalışılırsa mevcut kayıttaki izin verilmeyen metotlar, geçerlilik tarihi ve kota/daraltma özelleştirmeleri silinmez.
Sözleşme üzerinden erişim iznini kaldırma desteklenmez; bir kimlik bilgisinin API Proxy erişimini kesmek için API Proxy ACL sayfasından ilgili kaydın silinmesi gerekir.
Önceki Sözleşme/Protokol (Previous Contracts) Sekmesi
Bu bölümde mevcut sözleşme/protokolün türetildiği sözleşme/protokolün listesi yer alır.
