Genel Bakış
ORIONPOS API Entegrasyonu, ORIONPOS ile entegre olmak isteyen yazılımların satış, cari, ürün bilgileri gibi bir çok işlemin aktarımı ve senkronize edilmesine olanak sağlar. ORION API, yazılımınızı on-premise çalışan ORIONPOS sistemlerine bağlayan bir REST API’dir. Kimlik doğrulamadan menü senkronizasyonuna, adisyon sorgusundan şube yönetimine kadar restoran ve yiyecek-içecek işletmelerinin ihtiyaç duyduğu tüm entegrasyon noktalarına tek bir taban URL üzerinden erişebilirsiniz:https://api.orionpanel.com
ORIONPOS on-premise çalışan bir sistem olduğu için gönderdiğiniz tüm istekler tarafımızdan hedef Restorana iletilmektedir. Hedef restoranın server bilgisayarının kapalı olması, internetinin olmaması, internetinin yavaş olması, server bilgisayarının gereksinimleri karşılayamaması gibi durumlarda bu hizmetlerin kontrolünü sağlamanızı öneririz.
Kimlik Doğrulama
AccessToken ve oturum token’ı edinme adımlarını öğrenin; her isteği güvenli biçimde imzalayın.
Hız Limitleri
API’nin istek kotalarını ve limit aşımında dönen hata kodlarını inceleyin.
Şubeler
GetBranches ile tüm şubelerinizi listeleyin ve şube kodlarını entegrasyonunuzda kullanın.
Çekler
GetChecks ve GetCheckByCode endpoint’leriyle adisyon ve çek verilerine erişin.
Ürünler
Menü kalemleri, ilaveleri, grupları ve entegrasyon kodlarını yönetin.
Kimlik Doğrulama Rehberi
Token alma akışını ve tüm güvenlik adımlarını adım adım inceleyin.
Hızlı Başlangıç
Aşağıdaki adımları takip ederek birkaç dakika içinde ilk isteğinizi gönderebilirsiniz.1
AccessToken ile oturum token'ı alın
ORION Panel üzerinden size tanımlanan AccessToken değerinizi ve kullanıcı adı/parola bilgilerinizi
/GetToken endpoint’ine gönderin. Yanıtta dönen Token değerini bir sonraki adımda kullanacaksınız.2
Oturum token'ını saklayın
Başarılı yanıtta
Data[0].Token alanında dönen değer sizin oturum token’ınızdır. Bu token /GetToken dışındaki tüm isteklerde Token başlığı olarak kullanılır.Oturum token’ı 1 gün geçerlidir. Süresi dolduğunda
AccessToken değerinizle /GetToken endpoint’ini yeniden çağırarak taze bir token edinebilirsiniz.3
Şube kodunuzu öğrenin
/GetBranches endpoint’ini çağırarak hesabınıza bağlı tüm şubeleri listeleyin. Yanıtta her şubeye ait branchCode değeri döner; bu kodu sonraki sorgularda hedef şubeyi belirtmek için kullanırsınız.4
İstediğiniz endpoint'i kullanın
Artık oturum token’ınız ve şube kodunuz elinizde. Menü kalemlerini çekmek için
/GetMenuItems, adisyon sorgulamak için /GetChecks, ödeme türlerini listelemek için /GetPaymentTypes gibi ihtiyacınıza uygun endpoint’i çağırabilirsiniz. Kimlik doğrulama akışının tamamı için Kimlik Doğrulama sayfasını ziyaret edin.