Bu sayfada
> kaynaklar > belgeler > api > API anahtarları

API anahtarları

ProcessMind’de API anahtarı yönetimi

ProcessMind API ile entegrasyon kurmak için API anahtarları oluşturmanız ve yönetmeniz gerekir. API anahtarlarınızı nasıl oluşturacağınızı, kullanacağınızı ve güvenli hale getireceğinizi öğrenin.

ProcessMind hesabınızın ayarlarında “API anahtarları” bölümüne gidin. Burada Yeni ortam API anahtarı düğmesine tıklayarak yeni bir API anahtarı oluşturabilirsiniz. Anahtarınızı daha sonra tanıyabilmek için adlandırın.

API anahtarı oluşturma

image

Farklı uygulamalar veya hizmetler için birden fazla API anahtarı oluşturabilirsiniz. Her anahtarı bağımsız olarak yönetebilir, böylece diğer entegrasyonları etkilemeden gerektiğinde anahtarları iptal edebilirsiniz. Anahtar oluşturulduktan sonra kopyalayın ve güvenli bir yerde saklayın. Güvenlik nedeniyle anahtar, oluşturma sırasında yalnızca bir kez gösterilir.

image

warning

API anahtarlarınızı güvenli tutun ve bunları istemci tarafı kodunda veya herkese açık depolarda hiçbir zaman paylaşmayın. Bir anahtar ele geçirilirse hemen iptal edin ve yeni bir anahtar oluşturun.

Kuruluş API anahtarları

Kuruluş yöneticileri aynı sayfada kuruluş API anahtarları da oluşturabilir. Ortam anahtarlarından farklı olarak kuruluş anahtarı, kuruluşun tüm ortamlarında (tenant) çalışır. Böylece tek bir entegrasyon bunların tamamına hizmet verebilir. Kuruluş anahtarlarını şu amaçlarla kullanın:

  • Ortam API anahtarlarını hazırlayın: External API üzerinden tenant kapsamındaki anahtarları oluşturun, güncelleyin ve silin (/v1/tenant/{tenantId}/api-keys).
  • Tek kullanımlık giriş bağlantıları oluşturun: kendi ürününüzdeki bir kullanıcıyı kimliği doğrulanmış şekilde doğrudan ProcessMind’e gönderin (/v1/tenant/{tenantId}/users/{userId}/login-token).

Kapsamlar

Kapsam Yetkiler
read Tenant verilerini okur (listeleme/getirme uç noktaları). Varsayılan olarak açık.
write Tenant verilerini oluşturur, günceller ve siler. Varsayılan olarak açık.
uploadData Datatablelar için imzalı yükleme URL’leri ister. Varsayılan olarak açık.
sessions Tek kullanımlık giriş devir teslim belirteçleri oluşturur. Varsayılan olarak kapalı.

sessions kapsamını yalnızca giriş devir teslimi gereken anahtarlar için etkinleştirin ve bu anahtarları parola gibi koruyun: oluşturulan belirteç, parola istemi göstermeden kullanıcıyı giriş yaptırır. Kuruluş anahtarı, kuruluştaki tüm ortamların kullanıcıları için belirteç oluşturabilir. Ortam anahtarı ise yalnızca kendi ortamının kullanıcıları için belirteç oluşturabilir.

Tek kullanımlık giriş devir teslimi

POST /v1/tenant/{tenantId}/users/{userId}/login-token, kullanıcıya, ortama ve kuruluşa bağlı tek kullanımlık bir belirteç (60 saniye geçerli) ile bir url döndürür. Kullanıcının tarayıcısını bu URL’ye gönderin. Kullanıcı, e-posta bağlantısı veya başka bir kullanıcı gibi giriş yapma olmadan kendi oturumuyla ProcessMind’e ulaşır. İsteğin gövdesinde isteğe bağlı olarak belirli bir sayfaya doğrudan bağlantı vermek için path gönderebilirsiniz. Anahtarın sessions kapsamına sahip olması gerekir. Ayrıca yalnızca anahtarın hizmet vermesine izin verilen bir tenant için kullanıcı belirteci oluşturabilirsiniz.

Belirteç oluşturma işlemleri denetlenir, sıkı hız sınırlarına tabidir ve anahtar devre dışı bırakıldığında veya kullanıcı erişimini kaybettiğinde hemen engellenir. Belirteç yalnızca bir kez döndürülür ve hiçbir zaman günlüğe kaydedilmez.

İlgili konular

İlgili dokümantasyon