API ve Geliştirici

Workinno'nun API'si

Workinno, verinize dışarıdan erişmeniz için genel bir REST API sunar. Kendi yazılımınızı, Zapier veya Make gibi araçları ya da başka bir uygulamayı bu API üzerinden Workinno'ya bağlayabilirsiniz. Otomasyon bölümünün API ve Geliştirici sekmesi, ihtiyacınız olan tüm teknik bilgiyi tek sayfada toplar.

Bu sayfa geliştiriciler içindir; API'yi kendi yazılımına bağlayacak kişiye rehberlik eder.

Adres ve kimlik

Tüm istekler şu adrese gider: https://api.workinno.com/api/v1

Her istek bir API anahtarıyla doğrulanır. Anahtarı Authorization başlığında gönderirsiniz:

Authorization: Bearer wklive...

Anahtarı henüz oluşturmadıysanız API Anahtarları sayfasından oluşturun. Sayfadaki API anahtarı oluştur düğmesi de sizi oraya götürür. → API Anahtarları

Hız sınırı

Her anahtar için dakikada 100 okuma ve 30 yazma isteği hakkınız vardır. Her yanıt, kalan hakkınızı X-RateLimit-Remaining başlığında bildirir. Sınırı aşarsanız istek 429 hatasıyla döner ve bir süre beklemeniz gerekir.

Çift-istek koruması

Bir yazma isteğinde ağ koparsa isteği tekrar göndermeniz gerekebilir. Aynı işlemin iki kez kaydedilmesini önlemek için isteğe bir Idempotency-Key başlığı eklersiniz. Aynı anahtarla gönderilen tekrar, ilk isteğin yanıtını döndürür ve ikinci bir kayıt oluşturmaz. Bu koruma 24 saat geçerlidir.

Hata biçimi

Hatalar tutarlı bir gövdeyle döner. code alanı makine tarafından okunur, message alanı İngilizce bir açıklamadır:

{ "success": false, "error": { "code": "errors.apiKey.scope_denied", "message": "This API key is not authorized for this action", "path": "/api/v1/tasks" } }

Sayfalama ve arama

Listeleme uç noktaları page, limit ve q (arama) parametrelerini kabul eder. Tek istekte en fazla 100 kayıt döner:

GET /api/v1/tasks?page=1&limit=20&q=demo

Erişilebilen kaynaklar

API şu an dört kaynak için tam erişim sunar: Görevler, Müşteriler (kişi), Firmalar ve Projeler. Her kaynak için beş işlem vardır: listeleme, oluşturma, tek kayıt okuma, güncelleme ve silme. Her işlem, o işlemi yapabilmek için anahtarın taşıması gereken yetkiyi de belirtir. Örneğin görev listelemek için anahtarın görev görüntüleme yetkisi olmalıdır.

Kaynakların ve uç noktaların tam listesini API ve Geliştirici sayfasında, her satırın gerektirdiği yetkiyle birlikte görürsünüz. Makine okunur tam şemayı ise OpenAPI şeması düğmesinden alırsınız; bu dosyayı kod üreten araçlara verebilirsiniz.

Yetkiler

API ve Geliştirici sayfasını görüntülemek için otomasyon görüntüleme yetkisi yeterlidir. API'yi gerçekten kullanmak için bir API anahtarı gerekir; anahtarın yapabilecekleri, ona verdiğiniz yetkilerle sınırlıdır. → API Anahtarları

İlgili: API Anahtarları, Otomasyonlar, Webhook Teslimatları