Kibi REST API, harici uygulamaların, Yapay Zeka asistanlarının ve otomasyonların Kibi Connect verilerine erişmesini sağlar. API aracılığıyla Wiki sayfalarından haber girişlerine, görevlere ve takvim girişlerine kadar içerik okunabilir ve yazılabilir.
REST API, önce bir sistem yöneticisi tarafından etkinleştirilmelidir. Ayarlar şu adrestedir:
Ayarlar → Entegrasyonlar → REST API
Burada şu seçenekler mevcuttur:
REST API'yi Etkinleştir
API arayüzünü açar veya kapatır.
Token Oluşturmayı Belirli Rollerle Sınırla
Etkinleştirildiğinde, yalnızca seçilen rollere sahip kullanıcılar API tokeni oluşturabilir. Tek tek kullanıcılar, profilindeki Güvenlik sekmesindeki işlev erişimi aracılığıyla yetkilendirilebilir.
IP Kısıtlamasını Etkinleştir
Etkinleştirildiğinde, yalnızca belirtilen IP adresleri API'ye erişebilir. Bu, ek bir güvenlik katmanıdır.
Her kullanıcı, kendi kullanıcı profilinden API tokeni oluşturabilir. Bunun için şu adrese gidin:
Kullanıcı Profili → Entegrasyonlar → Yeni Token Oluştur
Token oluştururken şunları belirlersiniz:
Ad
Açıklayıcı bir ad (örn. "Yapay Zeka Aracı", "ERP Entegrasyonu", "İş Akışı Otomasyonu").
İzinler (Kapsamlar)
Yalnızca entegrasyonun gerçekten ihtiyaç duyduğu izinleri seçin (En Az Yetki Prensibi).
Son Kullanım Tarihi (opsiyonel)
Opsiyonel olarak, tokenin otomatik olarak geçersiz hale geleceği bir son kullanım tarihi belirlenebilir.
Oluşturulduktan sonra token değeri yalnızca bir kez gösterilir. Bunu hemen kopyalayın ve güvenle saklayın (örn. bir şifre yöneticisinde). Kaybedilmesi durumunda token iptal edilmeli ve yeni bir token oluşturulmalıdır.
Aşağıdaki kapsamlar, API tokeninin çeşitli alanlara erişimini kontrol eder:
Kapsam |
Açıklama |
|---|---|
|
Yayımlanan gönderileri ve haberleri okuma |
|
Gönderi oluşturma, güncelleme ve silme |
|
Wiki sayfalarını ve belgeleri okuma |
|
Wiki sayfaları oluşturma ve güncelleme |
|
Takvim girişlerini okuma |
|
Takvim girişleri oluşturma, güncelleme ve silme |
|
Genel grupları, üyeleri, gönderileri ve dosyaları okuma |
|
Anketleri ve sonuçları okuma |
|
Görevleri okuma (yalnızca kendi veya atanan görevler) |
|
Görev oluşturma ve güncelleme |
|
Genel kullanıcı dizinini okuma (özel veriler hariç) |
|
Sohbetleri ve mesajları okuma |
|
Mesaj gönderme (botlar ve otomasyonlar için) |
|
Kullanıcı bildirimlerini okuma |
|
Kullanıcılara bildirim gönderme (Push dahil) |
|
Varlıklar arası arama |
Tüm API istekleri, tokenı Authorization başlığında Bearer token olarak içermelidir:
curl -H "Authorization: Bearer kbc_IhrTokenHier" \
https://firma-adiniz.kibi.de/api/v1/wiki
API temel URL'si: https://firma-adiniz.kibi.de/api/v1
Tüm uç noktaların ve parametrelerin tam API belgeleri, doğrudan Kibi Connect'te şu adreste mevcuttur:
Etkileşimli Belge: Kullanıcı Profili → Entegrasyonlar → API Belgeleri
OpenAPI Spesifikasyonu (JSON): Kullanıcı Profili → Entegrasyonlar → OpenAPI JSON
Önemli uç noktaların özeti:
Alan |
Uç Nokta |
Açıklama |
|---|---|---|
Wiki |
|
Wiki sayfalarını listeleme |
Wiki |
|
Wiki sayfası oluşturma |
Haberler |
|
Gönderileri listeleme |
Görevler |
|
Görevleri listeleme |
Takvim |
|
Takvim girişlerini listeleme |
Sohbet |
|
Doğrudan mesaj gönderme |
Kullanıcılar |
|
Kullanıcı dizinini listeleme |
Arama |
|
Varlıklar arası tam metin arama |
Oluşturulan tüm tokenler, Kullanıcı Profili → Entegrasyonlar altındaki genel bakışta gösterilir. Burada şunları görebilirsiniz:
Token adını
Atanan izinleri
Tokenin son kullanım zamanını
Bir tokeni iptal etme olanağını
Veri Erişimi: API tokenleri, yalnızca ilgili kullanıcının erişimi olan verilere erişebilir. Kullanıcının izinleri geçerliliğini korur.
Güvenlik: API tokenlerini asla halka açık paylaşmayın. Tokenleri ortam değişkenlerinde veya bir gizli yöneticisinde saklayın, kaynak kodunda değil.
En Az Yetki: Yalnızca minimum gerekli izinleri verin. Bir Wiki entegrasyonu için tokenin sohbete erişimine gerek yoktur.
Son Kullanım Tarihi: Geçici entegrasyonlar için son kullanım tarihi belirleyerek güvenliği artırın.
İptal: Artık ihtiyaç duyulmayan tokenleri derhal token genel bakışından iptal edin.