API Dokümantasyonu

Shifton API ile Bağlantı ve Çalışma

Shifton API’si size platformun tüm anahtar özelliklerine erişim sağlar — zamanlama yönetiminden dış İKbordro, , ve analitik sistemlere entegrasyonlara kadar..
API’yi kullanarak süreçleri otomatikleştirebilir ve Shifton’u şirketinizin dahili hizmetleri ile entegre edebilirsiniz.


API Belgeleri

Belgelerimizin iki sürümünü destekliyoruz:


Başlarken

Bir API Anahtarı Alın

Shifton platformundaki şirket ayarlarınızda bir API anahtarı.
oluşturun.Yetkilendirme başlık üzerinden yapılır:

Authorization: Bearer {your_api_key}

İlk İsteğinizi Yapın

Örneğin, çalışanların bir listesini almak için:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

Örnek yanıt:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

API’yi İş Akışlarınıza Entegre Edin

  • Vardiyaları otomatik olarak oluşturun ve değiştirin

  • Tatil ve hastalık izni taleplerini yönetin

  • Verileri bordro sistemlerine aktarın

  • Özel panolar ve raporlar oluşturun


Çekirdek API Özellikleri

  • Çalışanlar – ekleme, düzenleme ve rol yönetimi

  • Çizelgeler – vardiya yaratma, ayarlama, çalışmayı planlama

  • İzinler ve Devamsızlıklar – tatil ve hasta izni taleplerini yönetme

  • Raporlama – zaman, bordro ve katılım verilerini dışa aktarma


Hata Kodları

Shifton API, standart HTTP durum kodlarını:

  • 200 — Başarılı istek

  • 201 — Nesne başarıyla oluşturuldu

  • 400 — Geçersiz parametreler

  • 401 — Yetkilendirme hatası (geçersiz API anahtarı)

  • 403 — Erişim engellendi

  • 404 — Kaynak bulunamadı

  • 500 — Sunucu hatası


Kullanım İpuçları

  • Her zaman yeni API sürümünü yeni entegrasyonlar için kullanın

  • Kullan Postman veya curl test için

  • Oran sınırlarına saygı göster engellenmemek içinEngellenmemek için oran sınırlarına saygı göster.

  • Hala eski belgelerle çalışan entegrasyonları güncelle


Bu gönderiyi paylaş