Partner API · v1.0.0
Orkelis Partner API, sözleşmeyle etkinleştirilen işletmelerin randevu, müşteri, hizmet, uygunluk, rapor ve webhook akışlarını sunucu tarafında bütünleştirmesi içindir. Erişim varsayılan olarak kapalıdır ve her anahtar yalnızca verilen kapsamlarla çalışır.
Base URL
https://app.getorkelis.com/api/v1Kimlik
Bearer orq_…JWT değil; bir kez gösterilen kapsamlı API anahtarı.
Oran sınırı
100 istek / dakika
İşletme, HTTP metodu ve endpoint bazında.
Tüm başarılı yanıtlar data ve meta zarfını kullanır.
/api/v1/appointmentsRandevuları tarih, durum ve personel filtresiyle sayfalı olarak döndürür.
partner:appointments:readParametreler
date · opsiyonel — YYYY-MM-DD günü.status · opsiyonel — Randevu durumu.staff_id · opsiyonel — Personel UUID değeri.limit · opsiyonel — Sayfa boyutu.offset · opsiyonel — Başlangıç kaydı./api/v1/appointmentsBir müşteriye, şubeye, personele ve en az bir hizmete bağlı randevu oluşturur.
partner:appointments:createJSON gövdesi
customer_id · zorunlu — Müşteri UUID değeri.staff_id · zorunlu — Personel UUID değeri.branch_id · zorunlu — Şube UUID değeri.service_ids · zorunlu — 1-10 hizmet UUID değeri.scheduled_at · zorunlu — ISO 8601 başlangıç zamanı.duration · zorunlu — 5-480 dakika.room_id · opsiyonel — Opsiyonel oda UUID değeri.device_id · opsiyonel — Opsiyonel cihaz UUID değeri.notes · opsiyonel — En fazla 1.000 karakter not.source · opsiyonel — Randevu kaynağı./api/v1/appointments/{id}Tek bir randevuyu ilişkili hizmet kimlikleriyle döndürür.
partner:appointments:readParametreler
id · zorunlu — Randevu UUID değeri./api/v1/appointments/{id}İzin verilen alanları ve geçerli durum geçişlerini uygular.
partner:appointments:updateParametreler
id · zorunlu — Randevu UUID değeri.JSON gövdesi
status · opsiyonel — Yeni randevu durumu.scheduled_at · opsiyonel — Yeni ISO 8601 zamanı.duration · opsiyonel — 5-480 dakika.notes · opsiyonel — En fazla 2.000 karakter not.staff_id · opsiyonel — Personel UUID değeri.room_id · opsiyonel — Oda UUID değeri./api/v1/appointments/{id}Kaydı silmek yerine randevu durumunu cancelled yapar.
partner:appointments:deleteParametreler
id · zorunlu — Randevu UUID değeri./api/v1/customersMüşteri kayıtlarını arama ve sayfalama ile döndürür.
partner:customers:readParametreler
search · opsiyonel — Ad, telefon veya e-postada en fazla 100 karakter arama.limit · opsiyonel — Sayfa boyutu.offset · opsiyonel — Başlangıç kaydı./api/v1/customersYeni müşteri kaydı oluşturur.
partner:customers:createJSON gövdesi
full_name · zorunlu — 2-200 karakter ad.phone · zorunlu — 10-20 karakter telefon.email · opsiyonel — Opsiyonel e-posta.gender · opsiyonel — Opsiyonel cinsiyet değeri.birth_date · opsiyonel — YYYY-MM-DD doğum tarihi.notes · opsiyonel — En fazla 2.000 karakter not.tags · opsiyonel — En fazla 20 etiket./api/v1/customers/{id}Tek bir müşteri kaydını döndürür.
partner:customers:readParametreler
id · zorunlu — Müşteri UUID değeri./api/v1/customers/{id}Müşterinin izin verilen profil alanlarını günceller.
partner:customers:updateParametreler
id · zorunlu — Müşteri UUID değeri.JSON gövdesi
full_name · opsiyonel — 2-200 karakter ad.phone · opsiyonel — 10-20 karakter telefon.email · opsiyonel — E-posta veya null.is_active · opsiyonel — Aktiflik durumu.tags · opsiyonel — En fazla 20 etiket.notes · opsiyonel — En fazla 2.000 karakter not./api/v1/servicesİşletmenin aktif hizmetlerini döndürür.
partner:services:read/api/v1/servicesYeni bir hizmet oluşturur.
partner:services:createJSON gövdesi
name · zorunlu — 2-200 karakter hizmet adı.category_id · opsiyonel — Kategori UUID değeri.duration · zorunlu — 5-480 dakika.price · zorunlu — Negatif olmayan fiyat.description · opsiyonel — En fazla 2.000 karakter açıklama.is_active · opsiyonel — Aktiflik durumu./api/v1/availabilityBir gün için 30 dakikalık adımlarla uygun randevu başlangıçlarını döndürür.
partner:availability:readParametreler
date · zorunlu — YYYY-MM-DD günü.staff_id · opsiyonel — Personel UUID değeri.service_id · opsiyonel — Süre için hizmet UUID değeri./api/v1/staffAktif personel kayıtlarını döndürür.
partner:staff:read/api/v1/analyticsTarih aralığındaki kıyas ve operasyon metriklerini döndürür.
partner:analytics:readParametreler
from · zorunlu — Başlangıç günü.to · zorunlu — Bitiş günü./api/v1/reports/summarySeçilen dönem için gelir, randevu ve müşteri özetini döndürür.
partner:reports:readParametreler
period · opsiyonel — Rapor dönemi./api/v1/webhooksİmzalama secret değerlerini göstermeden endpointleri listeler.
partner:webhooks:read/api/v1/webhooksHTTPS hedefini doğrular ve imzalama secret değerini yalnızca bu yanıtta gösterir.
partner:webhooks:createJSON gövdesi
url · zorunlu — Standart 443 portunda herkese açık HTTPS URL.description · opsiyonel — En fazla 200 karakter açıklama.events · zorunlu — Desteklenen olay adları veya *./api/v1/webhooks/{id}Secret değerini göstermeden tek endpointi döndürür.
partner:webhooks:readParametreler
id · zorunlu — Webhook UUID değeri./api/v1/webhooks/{id}Endpointi ve yeni teslimat yeteneğini kaldırır.
partner:webhooks:deleteParametreler
id · zorunlu — Webhook UUID değeri.Erişim açılmadan önce veri kapsamı, anahtar rotasyonu, webhook imza doğrulaması, hata/yeniden deneme davranışı ve test ortamı müşteriyle yazılı olarak doğrulanır. OpenAPI belgesi istemci üretimi için başlangıçtır; gerçek kabul testi yerine geçmez.