HibritİK REST API
Web ve mobil uygulamaların kullandığı API’nin aynısı; API anahtarıyla kimlik doğrulama, rol izinleriyle sınırlı erişim ve kurum içi kurulumda aynı uç noktalar.
Nasıl çalışır?
REST ve JSON
Tüm uç noktalar /api/ altında, JSON gövdeli HTTP istekleriyle çalışır. Web ve mobil uygulamalar da aynı API’yi kullanır; ayrı bir “entegrasyon API’si” yoktur.
API anahtarı ile kimlik doğrulama
Kurum yöneticisi entegrasyon için bir rol seçerek anahtar üretir (hbk_…). Anahtar X-Api-Key başlığıyla gönderilir ve yalnızca o rolün izinleriyle çalışır; sunucuda yalnızca SHA-256 hash’i saklanır.
İzin bazlı erişim
Her uç nokta bir izinle korunur (ör. görev listeleme, görev oluşturma). Anahtarın rolünde olmayan izinler 403 ile reddedilir; kurum verisi kiracı filtresiyle otomatik sınırlanır.
Başkası adına ve çok firmalı kullanım
Rolünde integration.act_as izni olan anahtar, X-On-Behalf-Of başlığıyla (üyelik Id’si ya da e-posta) bir çalışan adına işlem yapar; her işlem denetim kaydına yazılır. Birden çok firmaya kopyalanan anahtarda firma X-Tenant-Id ile seçilir.
Bulutta ve kurum içinde aynı API
Bulut adresi api.hibritik.com’dur; kurum içi kurulumda aynı API kurumun kendi alan adında çalışır. OpenAPI 3 dokümanı sözleşme aşamasında paylaşılır.
Entegrasyon projeleri
Hazır bağlayıcı sunmuyoruz. Mevcut İK, muhasebe ya da benzeri sistemlerinizle veri alışverişini, ihtiyacınıza göre planlanan bir proje olarak REST API üzerinden birlikte kuruyoruz.
Örnek istek
Web ve mobil uygulamaların kullandığı API’nin aynısı; API anahtarıyla kimlik doğrulama, rol izinleriyle sınırlı erişim ve kurum içi kurulumda aynı uç noktalar.
curl https://api.hibritik.com/api/tasks?mine=true \
-H "X-Api-Key: hbk_xxxxxxxx_................................" \
-H "Accept: application/json"curl -X POST https://api.hibritik.com/api/tasks \
-H "X-Api-Key: hbk_xxxxxxxx_................................" \
-H "X-On-Behalf-Of: [email protected]" \
-H "Content-Type: application/json" \
-d '{ "title": "Aylık rapor", "description": "Ekim raporu hazırlanacak" }'Dört adımda entegrasyon
- 1Entegrasyon rolü tanımlayınYönetim panelinde yalnızca gereken izinleri içeren bir rol oluşturun; örneğin sadece görev okuma ve oluşturma.
- 2API anahtarı üretinAPI anahtarları ekranında rolü seçip anahtar üretin. Anahtar yalnızca bir kez gösterilir; güvenli bir sır deposunda saklayın.
- 3İsteklerinizi gönderinHer isteğe X-Api-Key başlığını ekleyin. Hatalar RFC 9457 ProblemDetails biçiminde, kullanıcı dilinde döner.
- 4Gerekirse iptal edinAnahtar ekrandan anında iptal edilir; başkası adına yapılan tüm işlemler denetim kaydında görünür.
Uç nokta alanları
API, ürünün tüm modüllerini kapsar; aşağıdakiler en sık kullanılan alanlardır. Tam liste OpenAPI dokümanındadır.
/api/tasksGörevler, alt görevler, pano ve Gantt/api/projectsProjeler ve sprintler/api/project-requestsProje talepleri ve onay/api/leaveİzin talepleri/api/overtimeFazla mesai/api/performancePerformans dönemleri/api/qualityKalite ve DÖF/api/vehicle-requestsAraç talepleri ve filo/api/communicationDuyuru, doküman ve anket/api/usersKullanıcılar ve üyelikler/api/departmentsDepartmanlar/api/api-keysAPI anahtarları
Sık sorulan sorular
API dokümanı herkese açık mı?
OpenAPI 3 dokümanı bulut adresinde herkese açık yayımlanmaz; entegrasyon planlanırken ya da sözleşme aşamasında paylaşılır. İletişim formundan talep edebilirsiniz.
API anahtarı kurumun tüm verisine erişir mi?
Hayır. Anahtar yalnızca kendisine verilen rolün izinleriyle çalışır; rolde olmayan uç noktalar reddedilir. Başkası adına işlem için ayrıca integration.act_as izni gerekir.
Kurum içi kurulumda API farklı mı?
Hayır. Kurum içi kurulum bulut sürümüyle aynı yazılımdır; API kurumun kendi alan adında, aynı yollarla çalışır.
Entegrasyon ya da özel modül mü planlıyorsunuz?
Kurum içi kurulum, mevcut sistemlerinizle veri alışverişi ve kurumunuza özel modül geliştirme için kapsamı birlikte belirleyelim; OpenAPI dokümanını bu aşamada paylaşıyoruz.