API

Başka programlar DocSecBox'a uygulama programlama arayüzü (API) üzerinden erişir. Bu sayfada API'nin adresini görür, erişimlerin nereden yapılabileceğini belirler ve API'yi kullanabilecek uygulamaları kaydedersiniz.

Ek modül

API erişimi ücretli bir ek modüldür. Modül olmadan Ayarlar › Uygulama altında API öğesi bulunmaz. Modülün açık olup olmadığını Lisans sayfası gösterir.

Yalnızca yöneticiler için

Sayfayı yalnızca yöneticiler görür. Roller altında Yalnızca süper yöneticiler program ayarlarını değiştirebilir açıksa sayfayı yalnızca süper yöneticiler görür.

API'nin adresi

API kartı, HTTP REST API'sinin temel URL'si altında başka programların API'ye eriştiği adresi verir. API dokümantasyonu bağlantısı API'nin bir açıklamasını açar. Tam belirtimi DocSecBox'unuzun işletmecisinden veya üreticiden talep üzerine alırsınız.

Erişime izin verme

API yalnızca kaynağına izin verdiğiniz istekleri kabul eder. İki seçenek de fabrika ayarı olarak kapalıdır. İkisi de kapalı olduğu sürece API her isteği reddeder ve sayfa bunu belirtir.

1. Ayarlar › Uygulama › API sayfasını açın.
2. API erişim ayarları kartında seçeneklerden birini veya ikisini işaretleyin: Dahili IP adreslerinden API erişimine izin ver ve Harici IP adreslerinden API erişimine izin ver.
3. Ayarları kaydet düğmesine tıklayın.

Belirleyici olan, isteğin geldiği adrestir. Sunucunun kendisinden yapılan bir çağrı ne dahili ne de harici sayılır. Bu çağrıyı iki seçenek de reddetmez.

Uygulama kaydetme

API'yi kullanan her programı bir uygulama olarak kaydedersiniz. Bu sırada hangi kullanıcıların bunun için anahtar alacağını belirlersiniz.

1. API uygulamaları kartında Uygulama ekle düğmesine tıklayın.
2. API uygulaması oluştur iletişim kutusunda Uygulama adı altına bir ad girin.
3. Kullanıcı listesinde anahtar alacak hesapları işaretleyin. Uzun listelerde Kullanıcı ara... alanı yardımcı olur.
4. Kaydet düğmesine tıklayın.

Kaydederken işaretlenen her hesap bir anahtar alır. Daha sonra bir işareti kaldırırsanız bu hesabın anahtarı geri alınır. Anahtarı yalnızca kullanıcının kendisi, profilde Üçüncü taraf anahtarları altında görür. Bu sayfada anahtar hiçbir zaman gösterilmez.

Uygulama listesi her satırda Ad, anahtarı olan Kullanıcılar sayısını ve Durum bilgisini gösterir: Etkin, tarihle birlikte … tarihine kadar etkin veya Devre dışı. Düzenle ile bir uygulamayı API uygulamasını düzenle iletişim kutusunda değiştirirsiniz.

Uygulamayı kullanımdan kaldırma

Bir uygulama silinemez. Uygulamayı bir tarih belirleyerek kullanımdan kaldırırsınız:

1. Uygulamanın satırında Düzenle düğmesine tıklayın.
2. Bir tarihten itibaren devre dışı bırak seçeneğini işaretleyin ve Şu tarihten itibaren devre dışı altında tarihi seçin.
3. Kaydet düğmesine tıklayın.

Bu tarihe kadar kullanıcıların anahtarları geçerli kalır.