KMTP API Kurallar Dokümanı Mayıs 2015, Sürüm 1.5.0

Transkript

1 KMTP API Kurallar Dokümanı Mayıs 2015, Sürüm Borsa İstanbul A.Ş., Tüm hakkı saklıdır.

2 Dokümanın Tarihçesi Tarih Versiyon Açıklama İlk sürüm Servis açıklamaları güncellendi Tüm servislerin json dönmesi sağlandı Sistem kontrol servisi cevap metni güncellendi Teklif ve işlem sorgularında harf değişikliği yapıldı. İşlem sorgularının teklifid dönmesi sağlandı ve DELETE çağrılarında content-type parametre zorunluluğu kaldırıldı. Teklif kaydet servisine musteriid=0 gönderilebilmesi sağlandı Teklif kuralları sorgusundan dönülen MetalStok bilgisine menşei alanı eklendi Alış Teklifleri sorgulama, Satış Teklifleri sorgulama ve işlemleri sorgulama servislerine tek seferde birden fazla metal kodu ile sorgulama yapılabilmesi için eklemeler yapıldı Son işlemlerde oturum açan üye alıcı ya da satıcı ise gerçeklesen işlemin hangi temsilci tarafından teklif olarak iletildiği eklendi. Üye listesi servis eklendi. İptal edilen teklifler servisi eklendi. Güncellenen teklifler servisi eklendi. Önceki seans işlemleri servisi eklendi. Önceki seans teklifleri servisi eklendi. Teklif no verilerek tek teklif detayı veren servis eklendi Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 2 / 24

3 İçindekiler Dokümanın Tarihçesi Dokümanın Amacı Kısaltmalar Bağlantı Mesaj Gönderim Yöntemi Mesaj Gönderim Sıklığı Kontrolü Bilgi Güncellik Kontrolü Mesaj Türleri Login Log Out Bilgi Güncellik Sorgulama Sistem Kontrol Duyuruları Sorgulama Teklif Verme Kuralları Sorgulama Teklif Gönder Teklif Güncelle Teklif İptal Alış Teklifleri Sorgulama Satış Teklifleri Sorgulama Tek Teklif Sorgulama Güncellenen Teklifleri Sorgulama İptal Edilen Teklifleri Sorgulama Önceki Seans Teklifleri Sorgulama İşlemleri Sorgulama Önceki Seans İşlemlerini Sorgulama Yetki Sorgulama Kasa Sorgulama Üye listesi sorgulama Müşteri listesi sorgulama Sistem Hata Kodları Listesi Açıklamaları Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 3 / 24

4 1 Dokümanın Amacı Borsa İstanbul, Kıymetli Madenler ve Kıymetli Taşlar Piyasası dâhilinde elektronik ortamda işlem gören Kıymetli Madenlerin Alım Satın İşlemleri Elektronik Borsa Sistemi ( EBS ) üzerinden gerçekleştirilmektedir. Geliştirilen KMTP API projesi ile birlikte, Borsa Üyelerinin, EBS Sistemine elektronik ortamda, bir uygulama programlama arayüzü üzerinden emir göndermesi amaçlanmaktadır. Bu doküman KMTP API ye nasıl bağlanılacağı, ve gönderilecek emir, sorgu taleplerinin nasıl ve hangi formatta olacağı ve yine sistemin hangi cevapları hangi formatta geri döndüreceği detaylarını açıklanmaktadır. 2 Kısaltmalar Kısaltma EBS API API kullanıcıları SSL Kısaltmanın Anlamı Elektronik Borsa Sistemi EBS yazılımı içerisinde bulunan web servis metotları API ye bağlı sistemler Bilgisayarlar arası veri iletişiminin şifreli bir şekilde yapılmasını sağlayan iletişim protokolü 3 Bağlantı KMTP API Web Servisi bağlantısı SSL üstünden sabit IP den gelinerek sağlanacaktır. API ye bağlanacak her sistem için API kullanıcı tanımı yapılacaktır. KMTP API ye üzerinden ulaşılacaktır. Tüm servis metotlarının adresleri ayrı ayrı 7. maddede verilmiştir. adresi API kullanımında oturum mantığı bulunmaktadır. API kullanılmaya başlanmadan önce login servisi üzerinden giriş yapılmalıdır. Giriş yapıldığında oturum başlatılarak oturuma özel güvenlik kodu dönülecektir (GUID). Daha sonraki API çağrılarında bu güvenlik kodu içerilmelidir. API nin çalışır olup olmadığı veya erişimin açık olduğu /api/sistem/kontrol servisinden kontrol edilebilir. API testleri adresi üzerinden gerçekleştirilecektir. Testlerde kullanılacak api kullanıcı bilgileri teste katılmak isteyen üyelere ayrı olarak iletilecektir. Test ortamında IP kısıtlaması uygulanmamaktadır Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 4 / 24

5 4 Mesaj Gönderim Yöntemi KMTP API; Web servis adreslerine HTTP, HTTP POST, HTTP PUT, HTTP DELETE çağrıları gönderilerek kullanılacaktır. Data gönderilip alınırken data formatı olarak JSON kullanılacaktır. KMTP API ye gönderilen mesajlar sıkıştırılmadan açık olarak veya gzip ile sıkıştırılarak gönderilebilir. API den dönen cevaplar her zaman gzip ile sıkıştırılmış olacaktır. API servislerinden alınan tüm tarih alanları :00:00 tarihinden itibaren geçen milisaniye(unix time) cinsiden süreyi ifade etmektedir. 5 Mesaj Gönderim Sıklığı Kontrolü KMTP API kullanımı belirli süre içerisinde belirli sayıya kadar çağrı yapabilme şeklinde sınırlandırılmıştır. Çağrı limitleri henüz netleşmediğinden daha sonra ayrı olarak duyurulacaktır. Test ortamında sınırlama bulunmamaktadır. 6 Bilgi Güncellik Kontrolü KMTP API yalnızca sorgulara cevap dönecek şekilde çalışmaktadır, broadcast ve push mekanizması bulunmamaktadır. Sisteme kaydedilen yeni teklif ve yeni işlem bilgileri API ye bağlı olan tüm sistemlere otomatik olarak gönderilmemektedir. API ye bağlı sistemler /api/sistem/durumbilgisi servisini kısa periyotlarla (Sn. de 1) çağırarak sistemde yeni bir bilgi veya güncelleme olup olmadığını kontrol etmelidirler. Durum bilgisi servisi; sistemdeki alış/satış tekliflerinin, işlemlerin, duyuruların güncelliği ile ilgili hash code ve id bilgileri dönmektedir. Bu servis saniyede bir çağrılarak bu değerler çekilmeli, değerlerde herhangi bir değişiklik olduğunda ilgili bilgi çekilerek güncellenmelidir. Bu servis ile ilgili detaylar 7.3 nolu maddede verilmiştir. 7 Mesaj Türleri 7.1 Login /EBS/api/authentication /login POST Request header Content-Type application/json Request body "kullaniciadi": "kullanıcıadı", "sifre": "şifre" Status code: http OK - Login başarılı durumu "authtoken":"5e1d84bb-b211-4e5a-a6c8-feafbd30b25a" Status code: http UNAUTHORIZED - Kullanıcı adı/şifre hatalı 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 5 / 24

6 - Tanımsız IP den gelindi "hatakodu":4041, "hatamesaji":"login başarısız" Açıklama Her oturumdan önce çağrılmalıdır. Belirli bir süre boyunca çağrı alınmazsa oturum otomatik olarak sonlanacaktır. Bu durumda tekrar login servisi çağrılarak yeni oturum açılmalıdır. Oturumun otomatik olarak ne kadar sürede sonlanacağı daha sonra duyurulacaktır. 7.2 Log Out /EBS/api/authentication/logout/oturumanahtarı DELETE Request header - Status code: http OK - Belirtilen oturum kapatıldı "mesaj":"oturum kapatıldı" - Belirtilen oturum bulunamadı Açıklama 7.3 Bilgi Güncellik Sorgulama Status code: http NOT_FOUND "hatakodu":4039, "hatamesaji":"açık oturum bulunamadı" Aktif bir oturumu sonlandırmak için kullanılır. Servise çağrı yapılırken, Login çağrısı sonucu size dönen oturumanahtarı bilgisi parametre olarak gönderilmelidir. /EBS/api/sistem/durumbilgisi Request header auth-token: oturumanahtarı Request body Status code: http OK "SD":true, "SN":573, "ATK": , "STK": , "IK": , "DN":171, "TKK": Gelen cevaptaki kısaltmalar aşağıda açıklanmaktadır: SD = Seans durumu. Aktif bir seansın bulunup bulunmadığını ifade eder. SN = Aktif seans numarası 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 6 / 24

7 ATK = Alış teklifleri hash code değeri STN = Satış teklifleri hash code değeri IK = İşlemler için hash code değeri DN = En son yayınlanan duyuru ID si TKK = Teklif kuralları hash code değeri Açıklama KMTP API içerisinde yeni teklifleri/işlemleri/duyuruları bağlı sistemlere haber veren bir mekanizma bulunmamaktadır. Bunun yerine tüm bağlı sistemler kısa aralıklarla sorgulama yapıp sistemde yeni bir teklif/işlem/duyuru olup olmadığını kontrol etmelidirler. Herhangi bir bilgide güncelleme olduğunda, örneğin sisteme yeni bir teklif eklendiğinde, ATK veya STK kodları farklı gelecektir. Bu durumda alisteklifleri veya satisteklifleri servisleri kullanılarak teklif listesi güncellenmelidir. Gün içerisinde, teklif Verme Kurallarında bir değişlik olabilir, örneğin sistemde olmayan yeni bir ayar değeriyle kasaya gün içinde metal girişi yapılabilir. Bu gibi durumlarda TKK değeri değiştirilecektir. Ve Teklif Verme Kuralları Sorgulama fonksiyonunu çağırarak son güncel parametrelere erişmeniz mümkün olacaktır. 7.4 Sistem Kontrol /EBS/api/sistem/kontrol Request header - Status code: http OK Açıklama "mesaj":"bağlantı başarılı" Sistemin çalışır, erişilebilir durumda olup olmadığını kontrol etmek için kullanılır. 7.5 Duyuruları Sorgulama /EBS/api/duyuru/duyurularigetir/kayitSayisi Request header auth-token: oturumanahtarı Status code: http OK [ "Id":171, "duyuruen":"duyuru başlığı eng", "duyurutr":"duyuru başlığı", 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 7 / 24

8 Açıklama "tarih": , "Id":172, "duyuruen":" duyuru başlığı eng 2", "duyurutr":" duyuru başlığı 2", "tarih": ] Sisteme son girilen duyurulardan belirtilen kadar kaydı getirmek için kullanılır. Web Servis çağrısı yapılırken kayitsayisi alanında son kaç adet duyuruyla ilgili kayda ulaşmak istendiği belirtilmelidir Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 8 / 24

9 7.6 Teklif Verme Kuralları Sorgulama /EBS/api/teklif/kurallar Request header auth-token: oturumanahtarı Status code: http OK Teklif parametreleri arasındaki ilişkiyi hiyerarşik olarak json formatında dönmektedir. Cevap örneği aşağıdaki gibidir. Açıklama Teklif gönderilirken gereken parametreler bu servisten alınan kurallar kullanılarak hazırlanmalıdır. Kurallar seans için geçerli olan valör tarihlerini de içerdiğinden her seans açılışında teklif kuralları tekrar çekilmelidir. metaltipleri. metalstoklari içerisinde yer alan menşei alanı 1:LBMA İçi; 2:LBMA Dışı; 3:Belirtilmemiş anlamlarına gelmektedir Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 9 / 24

10 7.7 Teklif Gönder /EBS/api/teklif/teklifkaydet POST Request header Content-Type: application/json auth-token: oturumanahtarı Request Örnek istek formatı aşağıda belirtilmiştir. - Kayıt başarılı - Parametreler hatalı veya parametreler arasında tutarsızlık var. - Kayıt esnasında gerçekleşen kontroller başarısız. "tekliftipi": "A", "metalkod": "AU", "metaltipid": 1, "islemtipid": 1, "emirtipid": 1, "fiyattipi": "TRY/KG", "metalstokid": 1, "fiyat": 99000, "miktar":1, "ayar":0, "agirlik":0, "valorid":2, "musteriid":22 Status code: http OK "teklifid":"84119" Status code: http NOT_ACCEPTABLE "hatakodu":hatakodu, "hatamesaji":"hatamesaji" Status code: http BAD_REQUEST "hatakodu":hatakodu, "hatamesaji":"hatamesaji" Açıklama - Teklif tipi alış için A, satış için S olmalıdır. - MetalKod, metaltipid, islemtipid, emirtipid, fiyattipi, metalstokid, valorid parametreleri teklif kuralları servisi üzerinden alınmalıdır. - Standart işlemler için metalstokid parametresi tanımlı olmalı, ayar ve ağırlık parametreleri sıfır olmalıdır. Standart olmayan işlemler için ise metalstokid sıfır olmalı, ayar ve ağırlık tanımlı olmalıdır. - Müşteri adına olmayan teklifler için musteriid=0 olmalıdır Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 10 / 24

11 7.8 Teklif Güncelle /EBS/api/teklif/teklifguncelle PUT Request header Content-Type: application/json auth-token: oturumanahtarı Request body "teklifid": "1", "miktar": "1", "fiyat": "80090" Status code:http OK - Teklif güncellenir "mesaj":"teklif başarıyla güncellendi" - Yeni parametreler geçerli değil Açıklama Status code: http BAD_REQUEST "hatakodu":hatakodu, "hatamesaji":"hatamesaji" Teklifi güncellemek için kullanılır. 7.9 Teklif İptal /EBS/api/teklif/teklifiptal/teklifID DELETE Request header auth-token: oturumanahtarı Status code: http OK - Teklif iptal edilir "mesaj":"teklif iptal edildi." - Teklif silinemedi Açıklama Status code: http BAD_REQUEST "hatakodu":hatakodu, "hatamesaji":"hatamesaji" Teklifi iptal etmek için kullanılır Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 11 / 24

12 7.10 Alış Teklifleri Sorgulama /EBS/api/teklif/alisteklifleri/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK Açıklama [ "teklifid":84521, "teklifno":436886, "metalstokid":1, "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":124, "uyekodu":"thl", "uyeunvani":"türkiye ABC BANKASI A.Ş", "musteriid":22, "metalkod":"au", "valorid":2, "boltekno":1, "fiyat":80004, "fiyattipi":"try/kg", "miktar":2, "tekliftarihi": , "tekliftipi":"a", "durumu":"aktif", "ayar":null, "agirlik":null,.] Aktif seanstaki açık bekleyen teklifleri listelemek için kullanılır. fonhesapno, uyeid, uyekodu, uyeunvani alanları yalnızca teklif çağrıyı yapan üyeye aitse dolu gelecektir. Diğer üyelere ait tekliflerin bu alanları boş gelecektir. METALKODLARI kısmına istenilen metallerin metal kodları, arasına - işareti konularak ilgili sorgulama yapılır. Örnek olarak altın ve gümüşe ait teklifler isteniyorsa /EBS/api/teklif/alisteklifleri/AU-AG şeklinde servis isteği yapılır Satış Teklifleri Sorgulama /EBS/api/teklif/satisteklifleri/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 12 / 24

13 Açıklama [ "teklifid":84416, "teklifno":436876, "metalstokid":1, "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":-1, "uyekodu":null, "uyeunvani":null, "musteriid":-1, "metalkod":"au", "valorid":3, "boltekno":0, "fiyat":1243, "fiyattipi":"usd/ons", "miktar":1, "tekliftarihi": , "tekliftipi":"a", "durumu":"gerceklesti", "ayar":null, "agirlik":null,.] Aktif seanstaki açık bekleyen teklifleri listelemek için kullanılır. fonhesapno, uyeid, uyekodu, uyeunvani alanları yalnızca teklif çağrıyı yapan üyeye aitse dolu gelecektir. Diğer üyelere ait tekliflerin bu alanları boş gelecektir. METALKODLARI kısmına istenilen metallerin metal kodları, arasına - işareti konularak ilgili sorgulama yapılır. Örnek olarak altın ve gümüşe ait teklifler isteniyorsa /EBS/api/teklif/satisteklifleri/AU-AG şeklinde servis isteği yapılır Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 13 / 24

14 7.12 Tek Teklif Sorgulama /EBS/api/teklif/TEKLIFNO Request header auth-token: oturumanahtarı Status code: OK Açıklama [ "teklifid":84416, "teklifno":436876, "metalstokid":1, "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":-1, "uyekodu":null, "uyeunvani":null, "musteriid":-1, "metalkod":"au", "valorid":3, "boltekno":0, "fiyat":1243, "fiyattipi":"usd/ons", "miktar":1, "tekliftarihi": , "tekliftipi":"a", "durumu":"gerceklesti", "ayar":null, "agirlik":null, ] Teklif numarasına göre sorgulanan teklifi getirmek için kullanılır. Eğer teklif sorguyu yapan üyeye aitse; fonhesapno, uyeid, uyekodu, uyeunvani alanları dolu gelecektir. Değilse bu alanlar boş gelecektir Güncellenen Teklifleri Sorgulama /EBS/api/teklif/guncellenenler/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK [ "teklifid":84416, 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 14 / 24

15 Açıklama "teklifno":436876, "metalstokid":1, "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":-1, "uyekodu":null, "uyeunvani":null, "musteriid":-1, "metalkod":"au", "valorid":3, "boltekno":0, "fiyat":1243, "fiyattipi":"usd/ons", "miktar":1, "tekliftarihi": , "tekliftipi":"a", "durumu":"aktif", "ayar":null, "agirlik":null,.] Aktif seanstaki geçerli, henüz işleme dönüşmemiş ve güncellenmiş teklifleri listeler. Eğer teklif sorguyu yapan üyeye aitse; fonhesapno, uyeid, uyekodu, uyeunvani alanları dolu gelecektir. Değilse bu alanlar boş gelecektir. METALKODLARI şeklinde belirtilen kısma listelenmek istenen metallerin metal kodları aralarına - işareti konularak ilgili sorgulama yapılır. Örneğin altın ve gümüşe ait henüz işleme dönüşmemiş ve güncellenmiş teklif listesi; /EBS/api/teklif/guncellenenler/AU-AG şeklinde sorgulanabilir İptal Edilen Teklifleri Sorgulama /EBS/api/teklif/iptaller/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK [ "teklifid":84416, "teklifno":436876, "metalstokid":1, 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 15 / 24

16 Açıklama "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":-1, "uyekodu":null, "uyeunvani":null, "musteriid":-1, "metalkod":"au", "valorid":3, "boltekno":0, "fiyat":1243, "fiyattipi":"usd/ons", "miktar":1, "tekliftarihi": , "tekliftipi":"a", "durumu":"iptal", "ayar":null, "agirlik":null,.] Aktif seanstaki iptal edilmiş teklifleri listeler. Eğer teklif sorguyu yapan üyeye aitse; fonhesapno, uyeid, uyekodu, uyeunvani alanları dolu gelecektir. Değilse bu alanlar boş gelecektir. METALKODLARI şeklinde belirtilen kısma listelenmek istenen metallerin metal kodları aralarına - işareti konularak ilgili sorgulama yapılır. Örneğin altın ve gümüşe ait iptal edilmiş teklif listesi; /EBS/api/teklif/iptaller/AU-AG şeklinde sorgulanabilir Önceki Seans Teklifleri Sorgulama /EBS/api/teklif/oncekiTeklifler/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK [ "teklifid":84416, "teklifno":436876, "metalstokid":1, "emirtipid":1, "fonhesapno":-1, "metaltipid":1, "islemtipid":1, "uyeid":-1, "uyekodu":null, "uyeunvani":null, 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 16 / 24

17 Açıklama "musteriid":-1, "metalkod":"au", "valorid":3, "boltekno":0, "fiyat":1243, "fiyattipi":"usd/ons", "miktar":1, "tekliftarihi": , "tekliftipi":"a", "durumu":"gerceklesti", "ayar":null, "agirlik":null,.] Bir önceki seanstaki teklifleri listelemek için kullanılır. fonhesapno, uyeid, uyekodu, uyeunvani alanları yalnızca teklif çağrıyı yapan üyeye aitse dolu gelecektir. Diğer üyelere ait tekliflerin bu alanları boş gelecektir. METALKODLARI kısmına istenilen metallerin metal kodları, arasına - işareti konularak ilgili sorgulama yapılır. Örnek olarak altın ve gümüşe ait teklifler isteniyorsa /EBS/api/teklif/iptaller/AU-AG şeklinde servis isteği yapılır İşlemleri Sorgulama /EBS/api/islem/sonislemlistesi/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK [ "islemno":168709, "saticiuyekodu":"thl", "saticiuyeunvani":"türkiye HALK BANKASI A.Ş", "saticiuyeid":124, "saticifonhesapno":-1, "saticimusterino":-1, "saticikomisyon":42, "saticiteklifid":436793, "aliciuyekodu":"thl", "aliciuyeunvani":"türkiye HALK BANKASI A.Ş", "aliciuyeid":124, "alicifonhesapno":-1, "alicimusterino":-1, "alicikomisyon":42, "aliciteklifid":436792, "metalstockid":1, 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 17 / 24

18 Açıklama "emirtipid":1, "metalkod":"au", "islemtipiid":1, "valorid":2, "seansno":573, "durum":"aktif", "fiyat":80000, "fiyattipi":"try/kg", "hacim":80000, "islemtarihi": , "takastarihi": , "miktar":1, islemyapankullanici": Hasan Yılmaz,.] Aktif seanstaki gerçekleşmiş işlemleri listelemek için kullanılır. Alıcı ve satıcıya ait fonhesapno, uyeid, uyekodu, uyeunvani, musterino, islemyapankullanici alanları yalnızca işlem çağrıyı yapan üyeye aitse dolu gelecektir. Diğer üyelere ait işlemlerin bu alanları boş gelecektir. İşlem bilgileri arasında aliciteklifid, saticiteklifid bilgileri yer almaktadır. İlgili teklif listelerinden bu Id ler kullanılarak işleme ait teklif bilgileri elde edilebilir. İşlem durumu değeri:aktif, FIKSING_BEKLIYOR, FIKSING_GERCEKLESTIRILMIS, PASIF, TAKAS_KAYDI_YAPILMIS değerlerinden biri olabilir. METALKODLARI kısmına istenilen metallerin metal kodları, arasına - işareti konularak ilgili sorgulama yapılır. Örnek olarak altın ve gümüşe ait işlemler isteniyorsa /EBS/api/ islem/sonislemlistesi /AU-AG şeklinde servis isteği yapılır Önceki Seans İşlemlerini Sorgulama /EBS/api/islem/oncekiIslemler/METALKODLARI Request header auth-token: oturumanahtarı Status code: OK [ "islemno":168709, "saticiuyekodu":"thl", "saticiuyeunvani":"türkiye HALK BANKASI A.Ş", "saticiuyeid":124, "saticifonhesapno":-1, "saticimusterino":-1, "saticikomisyon":42, "saticiteklifid":436793, "aliciuyekodu":"thl", 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 18 / 24

19 Açıklama "aliciuyeunvani":"türkiye HALK BANKASI A.Ş", "aliciuyeid":124, "alicifonhesapno":-1, "alicimusterino":-1, "alicikomisyon":42, "aliciteklifid":436792, "metalstockid":1, "emirtipid":1, "metalkod":"au", "islemtipiid":1, "valorid":2, "seansno":573, "durum":"aktif", "fiyat":80000, "fiyattipi":"try/kg", "hacim":80000, "islemtarihi": , "takastarihi": , "miktar":1, islemyapankullanici": Hasan Yılmaz,.] Bir önceki seanstaki gerçekleşmiş işlemleri listelemek için kullanılır. Alıcı ve satıcıya ait fonhesapno, uyeid, uyekodu, uyeunvani, musterino, islemyapankullanici alanları yalnızca işlem çağrıyı yapan üyeye aitse dolu gelecektir. Diğer üyelere ait işlemlerin bu alanları boş gelecektir. İşlem bilgileri arasında aliciteklifid, saticiteklifid bilgileri yer almaktadır. İlgili teklif listelerinden bu Id ler kullanılarak işleme ait teklif bilgileri elde edilebilir. İşlem durumu değeri:aktif, FIKSING_BEKLIYOR, FIKSING_GERCEKLESTIRILMIS, PASIF, TAKAS_KAYDI_YAPILMIS değerlerinden biri olabilir. METALKODLARI kısmına istenilen metallerin metal kodları, arasına - işareti konularak ilgili sorgulama yapılır. Örnek olarak altın ve gümüşe ait işlemler isteniyorsa /EBS/api/ islem/sonislemlistesi /AU-AG şeklinde servis isteği yapılır Yetki Sorgulama /EBS/api/uyebilgileri/yetki/METALKODU Request header auth-token: oturumanahtarı Status code: http OK "uyeislemyetkisibazdegeri": Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 19 / 24

20 Açıklama Bu servisten alınan yetki değeri istenilen bir valör ün çarpanı ile çarpılarak o valör için işlem yapma limiti olarak kullanılmalıdır. Örneğin bu servis sonucu olarak 1000 değeri alındığında T0 da işlem limiti olduğu sonucuna varılır. Valör çarpanları teklif verme kuralları servisinden alınmalıdır Kasa Sorgulama /EBS/api/uyebilgileri/kasa/METALKODU Request header Content-Type: application/json auth-token: oturumanahtarı Status code: http OK [ "id":707031, "sabitserino":"b-", "serino":"32649", "rafinerikodu":"jmi", "metalid":1, "ayar":995, "agirlik":1, "metaltipi":"külçe", "metalkod":"au", "musteriid":0, "fonhesapno":0, "uyekasagiristarihi": , "cevherdenuretim":false, ] Açıklama Üyenin kendisine, müşterilerine ve fon hesaplarına ait tüm metal bilgilerini döner Üye listesi sorgulama /EBS/api/uyebilgileri/uyeler Request header auth-token: oturumanahtarı Status code: http OK [ 2 3 "uyeid": 79, 4 "uyekisaunvan": "ADABANK", 5 "uyeunvan": "ADABANK A.Ş." 6, Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 20 / 24

21 Açıklama 8 "uyeid": 139, 9 "uyekisaunvan": "AG KIYMETLİ MADEN", 10 "uyeunvan": "AG KIYMETLİ MADENLER A.Ş" 11, "uyeid": 81, 14 "uyekisaunvan": "AHLATCI DÖVİZ", 15 "uyeunvan": "AHLATCI DÖVIZ VE KIY. MAD.TIC.A.S." 16, "uyeid": 147, 19 "uyekisaunvan": "AHLATÇI METAL RAFİNERİ", 20 "uyeunvan": "AHLATÇI METAL RAFİNERİ A.Ş." 21, "uyeid": 84, 24 "uyekisaunvan": "AKBANK", 25 "uyeunvan": "AKBANK T.A.Ş" 26, ] Bu Mesaj Tipi Cevap olarak üyeleri dönmektedir Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 21 / 24

22 7.21 Müşteri listesi sorgulama /EBS/api/uyebilgileri/musteriler Request header auth-token: oturumanahtarı Status code: http OK Açıklama [ "musteriid":22, "musteritipi":1, "tckn":" ", "isim":"isim Soyisim", "tel1":"(341) ", "tel2":null, "fax":null, "eposta":"eng@eng.com", "adres":"mopmpomopm", "websitesi":null, "aciklama":null, "kimlikno":" ", "uyruk":"tc", "anaadi":" ana adı", "babaadi":"baba adı", "dogumyeri":"kastamonu", "dogumtarihi":" ", "vergidairesi":null, "ticarisicildairesi":null, "ticarisicilkayitnumarasi":null, ] Bu Mesaj Tipi Cevap olarak Üyenin aktif müşterilerini dönmektedir. Müşteri tipi özel kişiler için 1, tüzel kişiler için 2 olacaktır Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 22 / 24

23 8 Sistem Hata Kodları Listesi Açıklamaları HATA KODU HATA AÇIKLAMASI 4001 Teklif için yeterli teminat yok Fiksing fiyatı girildiği için fiksing emri verilemez Seans T+0 valörlü işlemlere kapanmıştır. İşleminiz gerçekleştirilmedi Teklif fiyat aralık bilgisi bulunamadı. Lütfen sistem yöneticisi ile iletişim kurunuz Teklifiniz belirlenen fiyat aralığında değildir. Lütfen kontrol ederek tekrar deneyiniz Girilen ayar bilgisi metalin ayar yoğunluğuna uygun değildir Girilen miktar, alınmak istenen metalin birim ağırlığına uygun değildir Teklif no hesaplama işleminde hata oluştu. Lütfen tekrar deneyiniz Teklif işleminde eşleşme hatası. Lütfen tekrar deneyiniz Teklif kaydı yapılırken bir hata oluştu. Lütfen tekrar deneyiniz Geçersiz teklif tipi Geçersiz metal tipi Geçersiz işlem tipi Geçersiz emir tipi Geçersiz fiyat tipi Geçersiz Fiyat veya Miktar Girildi! 4017 Vade boş bırakılamaz Kullanıcı bulunamadı Geçersiz metal kodu Geçersiz vade Teklifteki metal id ve parametreleri uyumsuz Geçersiz müşteri Müşteri üyeye kayıtlı değil 4024 Geçersiz fon hesabı Fon üyeye kayıtlı değil Teklif kaydında hata Teklif bilgisi bulunamadı. İptal edilmek istenen teklif başka bir üyeye aittir. Lütfen kontrol ederek tekrar 4028 deneyiniz Teklif iptal işleminde hata oluştu Teklif için yeterli teminat yok 4031 Teklif güncellemede hata Teklif aktif durumda değildir, güncelleme işlemi yapılamaz. Güncellenmek istenen teklif başka bir üyeye aittir. Lütfen kontrol ederek tekrar 4033 deneyiniz Teklif güncelleme işleminde hata oluştu.lütfen tekrar deneyiniz 4035 Teklif kuralları oluşturulurken hata oluştu Teklif doğrulanamadı 4037 Metal kodu için seans objesi bulunamadı Kullanıcı için üye belirlenmemiş 4039 Açık oturum bulunamadı 4040 Bilinmeyen hata oluştu 4041 Login başarısız 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 23 / 24

24 4042 IP tanımlı değil 4043 İşlem limiti aşıldı 4044 Yetkisiz çağrı 2015 Borsa İstanbul A.Ş., Tüm hakkı saklıdır. Sayfa 24 / 24