Açık API (OpenAPI) nasıl kullanılır?

Açık API eklentimiz Vacation Tracker'ı kendi araçlarınıza bağlar. Bir API anahtarı oluşturun, neler yapabileceğini seçin ve verilerinizi okumak ve değiştirmek ya da bir şey değiştiğinde bildirim almak için kullanın.

API anahtarı nasıl oluşturulur?

1. app.vacationtracker.io/signin adresinden Vacation Tracker hesabınıza giriş yapın.
2. Sol menüden (Çalışma alanı ayarları altında) Entegrasyonlar bölümünü açın.
3. API kartına tıklayın. Açık API sayfası açılır.
4. API anahtarları bölümünde API anahtarı oluştur seçeneğine tıklayın.
5. Bir Anahtar adı girin. Bu adı yalnızca şirketinizdeki kişiler görür.
6. İsterseniz bir Entegrasyon adı girin. Kişiler bu adı Vacation Tracker'da anahtarın yaptığı her değişikliğin yanında görür, örneğin “Jane tarafından onaylandı (Bordro senkronizasyonu aracılığıyla)”. Yalnızca kişinin adının görünmesi için boş bırakın.
7. İzinler altında bir şablon seçin ve gerekirse ayarlayın (aşağıya bakın).
8. Son kullanma altında anahtarın ne zaman sona ereceğini seçin: 30 gün içinde, 90 gün içinde, 1 yıl içinde (önerilen) veya hiçbir zaman.
9. Özet bölümünü kontrol edin ve API anahtarı oluştur seçeneğine tıklayın.
10. Anahtarı kopyalayın ve güvenli bir yerde saklayın. Tam anahtar yalnızca bir kez, oluşturulduğunda gösterilir.

İzinleri seçme

Bir şablonla başlayın, ardından ayarlayın:

• Salt okunur: verileri görün, hiçbir şeyi değiştirmeyin. Raporlar ve gösterge panelleri için uygundur.
• İzin yönetimi: izin talep edin, ekleyin ve onaylayın. Kullanıcıları ve izin türlerini okuyun.
• Çalışma alanı kurulumu: konumları, departmanları, izin türlerini, politikaları, tatilleri ve kullanıcıları ayarlayın.
• Özel: her izni kendiniz seçin.

Her izin Erişim yok, Okuma veya Okuma ve yazma olarak ayarlanabilir. Talepleri onaylama ve reddetme, gizli izin türü adlarını görme ve diğer kullanıcılar adına işlem yapma ayrı onay kutularıdır; bu nedenle bunları yalnızca aracınızın ihtiyacı varsa açın. Bir anahtar yalnızca sizin Vacation Tracker'da yapmanıza izin verilen işlemleri yapabilir.

Anahtarlarınızı yönetme

API anahtarları tablosu, çalışma alanınızdaki her anahtarı sahibi, izinleri, son kullanımı, son kullanma tarihi ve durumuyla birlikte listeler. Ayrıntılarını açmak için bir anahtara tıklayın; burada şunları yapabilirsiniz:

• Bu ayki kullanımı görün, anahtarın adını ve izinlerini düzenleyin.
• Veri değiştiren her isteği listeleyen Son etkinlik bölümünü kontrol edin.
• Aynı ad ve izinlerle yeni bir anahtar almak için Anahtarı yenile seçeneğine tıklayın. Eski anahtarın 24 saat (önerilen) veya 7 gün boyunca çalışmaya devam etmesini ya da hemen durmasını seçin.
• Anahtarı kalıcı olarak durdurmak için İptal et seçeneğine tıklayın.

Bir anahtarın süresi dolmadan 14 gün önce size e-posta göndeririz.

İlk isteğinizi gönderme

Temel URL https://api.vacationtracker.io/v2 adresidir. Anahtarınızı Authorization başlığında bearer token olarak gönderin:

Başarılı bir çağrı verileri data altında döndürür. Birden fazla sayfası olan listeler ayrıca bir nextToken içerir; sonraki sayfayı almak için bunu geri gönderirsiniz.

Bir sorun olursa yanıt; bir kod, açıklama ve çözüm içeren bir error içerir. Eksik veya bilinmeyen bir anahtar 401 döndürür. Bir isteğin gerektirdiği izne sahip olmayan bir anahtar, INSUFFICIENT_SCOPE ile birlikte 403 döndürür.

Webhook nasıl eklenir?

1. Açık API eklentisi sayfasında Webhook'lar bölümüne gidin ve Webhook'ları yönet seçeneğine tıklayın.
2. Webhook ekle seçeneğine tıklayın.
3. Olayları alacak Uç nokta URL'si değerini girin. HTTPS kullanmalıdır.
4. Olaylar altında İzin kararları, Tüm izin etkinlikleri, Tam bir kopyayı senkronize tut veya olayları kendiniz seçmek için Özel seçeneğini seçin.
5. Webhook ekle seçeneğine tıklayın.

Yalnızca görmenize izin verilen verilerle ilgili olayları alırsınız.

Kotalar ve hız sınırları

Sınırlar API anahtarı başına uygulanır:

• Ayda en fazla 30.000 istek.
• En fazla 50 isteklik ani artışla birlikte saniyede 10 istek.

Entegrasyonunuzun bundan fazlasına ihtiyacı varsa şirket adınızı, entegrasyonu ve beklediğiniz trafiği belirterek developers@vacationtracker.io adresine e-posta gönderin.

Sık sorulan sorular