Giriş

Bu doküman Ödeal ile İş ortağı arasında, ortak üye işyerlerine hizmet verebilmek ve karşılıklı mutabakatları sağlayabilmek için gerekli entegrasyonları içermektedir. API tarafından sunulan işlevleri ve parametreleri, istek ve yanıt yapısını, hata durumlarını ve genel entegrasyon sürecini tarif etmektedir

Entegrasyona başlayabilmeniz için üye işyeri tanımlarınızın yapılmış olması ve veri iletimi için yetkilendirme bilgilerinizi edinmiş olmanız gerekmektedir.

Entegrasyona dahil olmak için aşağıdaki adımları izlemelİsiniz :

1 - Odeal’a bir lead veya register kaydı iletilmelidir.
2 - Ödeal tarafında ilgili birimlerin kontrolleri sonrasında satış süreci tamamlanır.
3 - Cihaz gönderimi ve kurulum süreci başlatılır. (İş modeline göre değişiklik görülebilir)

  Bu profiller ve açıklamaları şu şekildedir;

 1- Ödemeye ait bilgilerin iletilmesi ile ("internal-basket"); Ödeme işlemi ile ilişkili olan, ürün ve müşteri bilgilerinin entegrasyonun sağlanması ile gerçekleşmektedir.

 2- Ödemeye ait bilgilerin uygulama iletilmesi ile ("external-basket-with-app"); Kendi uygulamanız üzerinden Ödeal uygulamasının açılması sağlanarak gerçekleştirilir. Uygulama açılırken paylaşılması gereken en önemli bilgi, satış işlemine ait sepet bilgisinin kendi sisteminize ait dış bir url den alınabiliyor olmasıdır. Mobil uygulamanız üzerinden, Ödeal uygulamasını açmak için gerekli olan örnek kodlara SEPET sekmesinden erişebilirsiniz.

 3- Web siteniz üzerinden ("external-basket-with-ecommerce-url"); eCommerceURL olarak tanımlayacağınız sayfa otomatik olarak Ödeal uygulaması üzerinde açılacaktır. Web siteniz üzerindeki Ürün Detay / Sepet ekranlarınız da "Ödeal ile Öde" seçeneğine basıldığında, Ödeal uygulamasına sepet bilgisinin tarafınızdan alınacağı url bilgisini iletmeniz yeterli olacaktır. Ödeal ile Öde seçeneği için vereceğiniz link https://basket.odeal.com/{referenceCode} şeklinde olmalı, url değeri sizden sepet modelini alabileceğimiz şekilde hazırlanmalıdır. Sizden beklenen sepet modeli için tıklayınız.

 4- Sepet bilgisi ile ödeme alınabilmesi ("external-basket-with-qr"); QR kod okutularak, yanıt olarak dönen url verisi ile tarafınızdan sepet bilgisinin alınması sonucu gerçekleşir. Sizden beklenen sepet modeli için tıklayınız.

 5- Sepet bilgisi ile ödeme alınabilmesi ("external-basket-with-barcode"); Barkod okutularak alınan kod, basketURL olarak tanımlanan url sonuna eklenerek tarafınızdan sepet bilgisinin alınması sonucu gerçekleşir. Sizden beklenen sepet modeli için Sepet/Basit Model adımından öğrenebilirsiniz .

 6- Sepet bilgisi ile ödeme alınabilmesi ("external-basket-with-code"); Uygulama üzerinde açık alana girilen kod, basketURL olarak tanımlanan url sonuna eklenerek tarafınızdan sepet bilgisinin alınması sonucu gerçekleşir. Sizden beklenen sepet modeli için Sepet/Basit Model adımından öğrenebilirsiniz.

İletişim için : [email protected] adresini kullanabilirsiniz.

stage url: https://stage.odealapp.com/api/v1
prod url: https://api.odealapp.com/api/v1

Hata Kodları :

Tüm servislerde ortak hata kodu yapısı bulunmaktadır. Genel format aşağıdaki gibidir. Servislere ait hata kodları detaylarında yer almaktadır.