API ve anahtarlar
Diğer sistemler Akollo’ya bir API anahtarıyla açık API üzerinden ulaşır. Anahtarları yöneticiler oluşturur. Her anahtar yalnızca gereken kapsamları taşır ve istendiği an iptal edilebilir.
API anahtarları
Entegrasyonlar → API anahtarları sayfası her anahtar için şunları listeler:
| Sütun | Gösterdiği bilgi |
|---|---|
| Ad | Anahtara verdiğiniz ad |
| Anahtar | Anahtarın ilk karakterleri |
| Servis hesabı | Anahtarın adına çalıştığı servis hesabı |
| Kapsamlar | Anahtarın neleri okuyabileceği |
| Son kullanma | Son kullanma tarihi |
| Son kullanım | Anahtarın en son ne zaman kullanıldığı |
| Durum | Onay bekliyor, Etkin, Döndürülüyor, İptal edildi ya da Süresi doldu |
Onay bekleyen bir anahtar, kimin onaylaması gerektiğini gösterir.
API anahtarı oluşturma
API anahtarları sayfasını açın
Entegrasyonlar → API anahtarları sayfasına gidin ve anahtar oluşturma formunu açın.
Ad verin ve servis hesabını seçin
Anahtara, hangi sistemin kullandığını anlatan bir ad verin. Anahtarın adına çalışacağı Servis hesabı’nı seçin. Bir anahtarın yapabilecekleri her zaman servis hesabının rolüyle sınırlıdır.
Kapsamları belirleyin
Anahtarın ihtiyaç duyduğu her kapsamı Okuma olarak ayarlayın, diğerlerini Yok olarak bırakın. İş öğeleri ve Süzgeçler kapsamları yalnızca okuma düzeyinde sunulur.
Son kullanma tarihini ve adresleri girin
Bir son kullanma tarihi seçin; anahtar en geç bir yıl içinde sona erer. İsterseniz anahtarın kullanılabileceği İzinli IP aralıkları’nı satır başına bir tane olacak şekilde yazın.
Anahtarı oluşturun ve saklayın
Anahtar oluştur’u seçin. Anahtar yalnızca bir kez gösterilir. Kopyalayın, güvenli bir yerde saklayın ve sakladığınızı onaylayın. Anahtar akl_live_ ya da akl_test_ ile başlar.
Not
Onay gerektiren bir anahtar, örneğin kayıt değiştirebilen bir anahtar, farklı bir yönetici onaylayana kadar bekler. Anahtarı oluşturan kişi onu onaylayamaz.
Anahtarı döndürme ya da iptal etme
- Döndür anahtarı yenisiyle değiştirir. Eski anahtar kısa bir bekleme süresi boyunca çalışmaya devam eder; böylece onu kullanan sistemi güncelleyebilirsiniz. Bu sırada anahtarın durumu Döndürülüyor olarak görünür.
- İptal et bir anahtarı istediğiniz an geri çeker.
Anahtarı bulun
Entegrasyonlar → API anahtarları listesinde anahtarı bulun.
Gerekçe yazarak iptal edin
İptal et’i seçin ve Neden alanını doldurun. Anahtarın durumu İptal edildi olur.
Açık API
Programlar /api/public/v1 adresini çağırır ve geliştirildikleri API sürümünün tarihini Akollo-Version başlığında gönderir.
- Okuma kapsamı olan bir anahtar projeleri, görevleri, izlenen çalışanları ve günlük süre özetlerini listeleyebilir ve tek tek getirebilir.
- İş öğeleri ve Süzgeçler kapsamları, anahtarın iş öğelerini okumasına ve aramasına, kayıtlı süzgeçleri ve görünümleri okumasına, bir iş öğesinin eklerini listeleyip indirmesine de olanak verir.
- Listeler bir sayfa kayıt ve sonraki sayfa için bir imleç döndürür. Her liste sayfa boyutu, imleç ve belirli bir andan sonraki değişiklikleri okumak için bir zaman kabul eder.
- Olmayan bir kayıt ile başka bir kuruma ait kayıt aynı görünür.
- Günlük özet yalnızca çağıranın o kişinin gününü görme izni varsa döner. Özette tarih, çalışılan ve sayılan süre ile rakamın güncel olup olmadığı yer alır. Etkinlik, ekran görüntüsü ya da görev dağılımı içermez.
- Hatalar problem belgesi olarak döner. Bir hata, başka bir kuruma ait kaydı hiçbir zaman anlatmaz.
- Dosyalar ve CSV dışa aktarımları kendi içerik türleriyle, olduğu gibi döner.
İstekler, yinelemeler ve sınırlar
Bir yazma isteği Idempotency-Key taşır. Böylece program, zaman aşımından sonra isteği güvenle yineleyebilir.
| Durum | Sonuç |
|---|---|
24 saat içinde aynı Idempotency-Key ve aynı gövde | İlk yanıt döner; yazma yeniden çalışmaz. |
Aynı Idempotency-Key, farklı gövde | Reddedilir. |
| İlk yanıt 64 KiB’den büyük | Saklanmaz. Aynı anahtarla yineleme reddedilir ve yeniden çalışmaz. |
| Dakikalık sınıra ulaşıldı | Her çağıranın dakikalık bir sınırı vardır. Yanıt, ne zaman yeniden deneneceğini bildirir. |
Geliştirici başvurusu
Etkin işlemlerin OpenAPI açıklaması /api/public/v1/openapi.json (ve .yaml) adresindedir.
Entegrasyonlar → Geliştirici sayfası, seçilen sürümdeki her uç noktayı gerekli kapsamı ve örnek bir curl isteğiyle gösterir. Örnekteki anahtar her zaman bir yer tutucudur; sayfa gerçek bir anahtarla hiçbir zaman istek göndermez. Kullanımdan kalkan ya da kapanış tarihi belli olan uç noktalar işaretlidir. Devre dışı bir modülün uç noktaları listelenmez.
Sık sorulan sorular
Hayır. Anahtar yalnızca bir kez gösterilir. Yeni bir anahtar almak için anahtarı döndürün; eski anahtar kısa bir bekleme süresi boyunca çalışmaya devam eder.
Onay gerektiren bir anahtar, örneğin kayıt değiştirebilen bir anahtar, farklı bir yönetici onaylayana kadar bekler. Anahtarı oluşturan kişi onu onaylayamaz.
Hayır. Bir anahtarın yapabilecekleri her zaman servis hesabının rolüyle sınırlıdır.
Evet; 24 saat içinde aynı Idempotency-Key ve aynı gövdeyi gönderirseniz ilk yanıtı alırsınız ve yazma iki kez çalışmaz.
Her çağıranın dakikalık bir sınırı vardır. Sınıra ulaşıldığında yanıt, ne zaman yeniden deneyeceğinizi bildirir.
İlgili sayfalar
Eşitleme ayrıntıları
Bir bağlantı kayıtları nasıl eşit tutar: gruplar ve sahipler, kayıt eşleştirme, alan eşlemesi, sorunlar ve kaynakta silinen kayıtlar.
Webhook’lar
Webhook’lar olayları anında taşır: gelen webhook’larla başka bir sistem Akollo’ya, giden webhook’larla Akollo başka bir sisteme haber verir.