İçeriğe geç

Geliştirici

biik REST API'si ve webhook'ları: neyi okuyabilir, neyi yazabilirsiniz, nereden başlamalı.

Geliştirici belgesi

biik'in REST API'si dış sistemlerin (bordro, muhasebe, erişim kontrolü, kendi raporlama aracınız) hesabınızdaki çalışan, organizasyon, izin ve vardiya kayıtlarını okumasını, çalışan oluşturup güncellemesini sağlar. Webhook'lar aynı kayıtlardaki değişiklikleri sizin adresinize bildirir.

Neler var

  • Okuma: çalışanlar, şirketler, şubeler, birimler, unvanlar, izin türleri, izin talepleri, izin bakiyeleri, yayımlanmış vardiya atamaları ve olay akışı.
  • Yazma: çalışan oluşturma (POST /api/v1/employees) ve güncelleme (PATCH /api/v1/employees/{id}). İzin, bordro ve puantaj yazma API'nin ilk sürümünde yoktur; bu işler üründen yapılır.
  • Webhook: çalışan, birim, izin, vardiya ve onay olaylarının imzalı bildirimleri.

Temel kurallar

  • Adres uygulamanın kendi adresidir, yol /api/v1 ile başlar. İstekler HTTPS ile gelir, kimlik yalnız Authorization: Bearer başlığıyla verilir.
  • Gövdeler JSON'dur; alan adları snake_case, kimlikler uuid, günler YYYY-MM-DD, anlar UTC'dir.
  • Anahtar yetki vermez, daraltır: bir anahtar, bağlı olduğu rolün göremediği kaydı göremez.
  • Hata gövdesi RFC 9457'dir (application/problem+json) ve makinece okunur bir code taşır.
  • Makinece okunur sözleşme /api/v1/openapi.json adresindedir (OpenAPI 3.1). Bu belgedeki başvuru sayfaları aynı dosyadan üretilir.

Nereden başlamalı

  1. Hızlı başlangıç: anahtar oluşturun, bir çalışan ekleyin, izinlerini okuyun.
  2. Kimlik ve kapsamlar: hangi kapsam neyi açar, sınıflı alanlar nasıl döner.
  3. Webhook: değişiklikleri sormak yerine bildirim alın.
  4. API başvurusu: bütün uçlar, alanlar ve örnek yanıtlar.