API anahtarını nasıl oluştururum?

Worktivity entegrasyonlar için ayrı bir salt okunur API sunuyor. Anahtar organizasyona ait ve onu taşıyan her istek, o organizasyonun tuttuğu her şeyi okuyabiliyor.

Anahtar oluşturmak

1. Kenar çubuğunun tepesindeki çalışma alanı adını açıp Workspace settings seçin.
2. API access sekmesini açın.
3. New API key düğmesine basın, en fazla otuz karakterlik bir ad verin ve Create key deyin.
4. Anahtarı entegrasyonunuza kopyalayın.

Uygulamanın arayüzü şimdilik İngilizce; yukarıdaki etiketler ekranda göreceğiniz karşılıklarıyla yazıldı.

Ad size ait bir not. Anahtarı kullanacak entegrasyonun adını verin ki ileride hangisinin kapatılacağı tahmin işi olmasın.

Anahtarı yeniden görmek

Liste anahtarı değil noktaları gösteriyor. Satırdaki Reveal düğmesi okunabilir değeri getiriyor ve değer yaklaşık kırk beş saniye sonra yeniden gizleniyor. Burada "yalnızca bir kez gösterilir" kuralı yok; anahtar istediğiniz kadar açılabiliyor.

Anahtar nasıl gönderiliyor

Yetkilendirme başlığıyla değil, x_api_key adlı bir sorgu parametresiyle:

https://open-api.useworktivity.com/Employee/List?x_api_key=YOUR_API_KEY

İstekler anahtar başına saniyede beş, dakikada yüz ve saatte yüz bin ile sınırlı. Bunun üstü 429 olarak geri dönüyor.

Anahtarı kapatmak ile silmek

• Kapatma: satırdaki durum anahtarı. O anahtarı taşıyan istekler bir sonraki çağrıdan itibaren reddediliyor, anahtarı geri açmak eski hâline döndürüyor. Bir entegrasyonu geçici olarak durdurmak için bu var.
• Silme: kalıcı. O anahtar üzerine kurulmuş her şey hata almaya başlıyor ve anahtar geri getirilemiyor.

Anahtar; çalışanları, ekipleri, puantajı, ekran görüntülerini, projeleri, izin kayıtlarını ve içgörüleri organizasyonun tamamı için okuyor. Sunucuda tutun; tarayıcıya, mobil uygulamaya ya da açık bir depoya koymayın.

Plan ve sınırlar

Yeni anahtar oluşturmak API erişimini içeren bir plan istiyor. Planınız içermiyorsa sekme var olan anahtarları yine listeliyor ve o anahtarlar çalışmaya devam ediyor, yani sızmış bir anahtar her koşulda kapatılabiliyor ya da silinebiliyor. Yükseltme için planı değiştirme yazısı var.

Bir organizasyon en fazla on anahtar tutabiliyor ve sekme sayıyı sizin için yazıyor. Worktivity bir anahtarın en son ne zaman kullanıldığını kaydetmiyor; tabloda böyle bir sütunun olmama sebebi bu.

Uç dokümantasyonu

Kart başlığındaki düğme Worktivity sitesindeki geliştirici sayfalarını açıyor; uçlar, parametreler ve örnekler orada. Ayarlar ekranının geri kalanı kurum ayarlarında neler var yazısında anlatılıyor.