Entegrasyonlara Genel Bakış
COS'a veri göndermek, COS'tan veri okumak ve dış API'den ölçüm çekmek farklı kimlik doğrulama akışlarıdır.
| İhtiyaç | Yol | Kimlik doğrulama |
|---|---|---|
| COS iş verilerini okumak veya izin verilen işlemi yapmak | REST API | Kullanıcı JWT'si; şirket kapsamlı isteklerde X-Tenant-ID |
| Bir dış sistemden KPI/KR ölçümü göndermek | Push Ölçüm API'si | x-api-key; şirket anahtardan belirlenir |
| Dış API'den zamanlanmış ölçüm almak | KPI API Entegrasyonu (Pull) | Dış servisin kimlik bilgileri entegrasyon ucuna kaydedilir |
API adresini belirleme
Kurulumunuzun yapılandırılmış API taban adresini kullanın. Web adresinden tenant alt alan adı veya /api/v1 öneki türetmeyin. Örneklerdeki sunucu adını kendi API adresinizle değiştirin. Kullanıcının rolü ve kayıt kapsamı REST API'de de geçerlidir.
Push için başlama
- Ayarlar → API Anahtarları altında ölçüm gönderecek sistem için bir anahtar oluşturun. Bu işlem yönetici yetkisi ve etkin anahtar sınırına tabidir.
- Anahtarı oluşturulduğunda bir kez kopyalayıp dış sistemin gizli bilgi deposuna kaydedin.
- KPI detayındaki Push API ile Ölçüm Gönder bölümünden doğru adres, KPI kimliği ve
kpiTypeörneğini alın. - İlk ölçümden sonra KPI'ın Ölçümler sekmesinde tarih/değeri kontrol edin.
Push anahtarı genel REST oturumu sağlamaz. İptal edilen, süresi dolmuş veya yetkisiz anahtarın istekleri reddedilir.
Pull için başlama
- Ayarlar → Entegrasyonlar altında dış servise bağlantıyı tanımlayın.
- KPI'ın Entegrasyon sekmesinde bu ucu ve değer/tarih eşlemelerini bağlayın.
- Bağlantıyı test edin ve çalıştırma sonucunu inceleyin. Sunucunun erişemediği ya da güvenlik politikası gereği engellenen adreslerden ölçüm alınamaz.
Dış servis bağlantısı için Pull rehberindeki alanları, JSONPath örneklerini ve hata açıklamalarını izleyin. Test servisi için Mock API rehberine bakın.
Dışa aktarma
OKR döneminin Sağlık & İlerleme görünümündeki CSV dışa aktarma, o anda görünen satırları indirir. Diğer ekranlar için yalnız ilgili rehberde ve ekranda sunulan dışa aktarma eylemini kullanın. Genel bir CSV kullanıcı/kaynak içe aktarma veya bütün modüller için Excel/PDF menüsü varsaymayın.
Entegrasyon anahtarlarını konuşma, kaynak kod veya ekran görüntüsünde paylaşmayın. Yeni bir sistem bağlamadan önce gönderilecek alanları, erişim kapsamını ve hedef sunucuyu kurumunuzla doğrulayın.