İş Akışı API Entegrasyonu

9. İş Akışı API Entegrasyonu

API entegrasyonu, iş akışının özel uygulamalar, arka uç servisler, webhook sistemleri veya otomasyon araçları üzerinden programatik olarak çalıştırılmasını sağlar.

Entegrasyon yöntemi seçildikten sonra Başla seçeneğini kullanarak API yapılandırmasına geçebilirsiniz.

Bu işlem, seçili iş akışına ait API Anahtarları ekranını açar.

Bu ekran üzerinden API anahtarı görüntülenebilir ve kopyalanabilir, istek zaman aşımı ve hız limiti ayarları yapılandırılabilir ve ilgili API dokümantasyonuna erişilebilir.

9.1. İş Akışı API Anahtarı​

API Anahtarı, seçili iş akışını harici sistemlerden çağırmak için kullanılan kimlik doğrulama bilgisidir.

Oluşturulan API anahtarı yalnızca seçili iş akışı için geçerlidir. Başka bir iş akışını çağırmak için ilgili iş akışına ait API anahtarının kullanılması gerekir.

API anahtarı görüntüleme seçeneğiyle görüntülenebilir veya kopyalama seçeneğiyle kopyalanabilir.

API anahtarı gizli tutulmalıdır. Anahtar, herkese açık kaynak kod depolarına veya yetkisiz kişilerin erişebileceği ortamlara eklenmemelidir.

9.2. İstek Zaman Aşımı​

İstek Zaman Aşımı, sunucunun yanıtını beklerken isteğin iptal edilmeden önce bekleyeceği maksimum süreyi belirler.

Bu değer, iş akışının gerçekleştirdiği işlemlerin süresine göre yapılandırılabilir.

9.3. Hız Limiti ve Anlık Tolerans​

Hız Limiti, API üzerinden saniye başına gerçekleştirilebilecek istek sayısını belirler.

Anlık Tolerans, kısa süreli istek yoğunluklarında izin verilen ek istek kapasitesini gösterir.

Bu ayarlar, iş akışına yapılan API isteklerinin kontrollü şekilde yönetilmesini sağlar.

9.4. API Anahtarını Yönetme​

Mevcut API anahtarı Yeniden Oluştur seçeneğiyle yenilenebilir veya Sil seçeneğiyle kaldırılabilir.

API anahtarı yeniden oluşturulduğunda mevcut entegrasyonlarda kullanılan eski anahtar geçersiz hale gelebilir. Bu durumda harici sistemlerde kullanılan API anahtarının da güncellenmesi gerekir.

9.5. API Dokümantasyonu​

API Dokümantasyonu, seçili iş akışına ait endpoint referanslarına, kimlik doğrulama bilgilerine ve istek örneklerine erişmek için kullanılır.

İlgili API dokümantasyonuna ulaşmak için Dokümantasyonu Aç seçeneği kullanılır.

Harici sistem entegrasyonu yapılırken ilgili endpoint, kimlik doğrulama ve istek bilgileri için API dokümantasyonu referans alınmalıdır.

9.6. Sık Karşılaşılan Hatalar​

API çağrısı başarısız oluyorsa kullanılan API anahtarının doğru ve geçerli olduğu kontrol edilmelidir.

Yetkilendirme hatası alınıyorsa API anahtarının ilgili iş akışına ait olduğundan emin olunmalıdır.

İş akışı çalıştırılamıyorsa ilgili iş akışının yayınlanmış olup olmadığı kontrol edilmelidir.

Zaman aşımı hatası alınıyorsa iş akışının çalışma süresi ile İstek Zaman Aşımı değeri birlikte kontrol edilmelidir.