BOTAŞ EBT BİLGİ YÖNETİM SİSTEMİ WEB SERVİSLERİ KULLANIM KLAVUZU 21.10.2013 Sürüm: 2.2.0 Sayfa 1 / 10
Giriş EBT Sisteminin, Web Servisleri birinci versiyonu, BOTAŞ ile yapılan ayrıştırma çalışmalarına paralel olarak geliştirilmiştir. Servisler, EBT Sistemindeki aktörler(taşıtanlar, Dağıtım Şirketleri) tarafından kullanılacaktır. Bu döküman, EBT Web Servisleri ne entegre olacak kurumlar için klavuz niteliği taşımaktadır. Web Servisleri metotları, bu metotların giriş ve çıkış parametreleri, dökümanda detaylı olarak açıklanmaktadır. Döküman, sırasıyla Genel Bilgiler Kullanıcı adı ve şifreler, Süreçler ve metotları, Metot detay açıklamaları Bölümlerini içermektedir. 1. Genel Bilgiler EBT Sistemi, Visual Studio.NET ortamında Framework 4.0 kullanılarak geliştirilmiştir. Skada yazılımlarında EBT Web Servislerine adaptaston çalışmalarının yapılabilmesi için ilk olarak test ortamında sunulacaktır. Daha sonra gerçek ortama alınacaktır. Yeni versiyon duyuruları önce test ortamı için yapılacak, versiyon gerçek ortama geçirilmeden bir hafta öncesinden duyurulacaktır. İlgililerin duyuruları takip etmeleri ve versiyon güncellemelerini kendi yazılımlarına test ortamında eklemelidirler. 2. Kullanıcı Adı ve Şifreler EBT Web Servislerine kullanıcı adı ve şifre ile ulaşılacaktır. Kullanıcı adı ve şifre her kurumun kendine ait olacaktır. Dağıtım şirketleri için gereken Kullanıcı Kodu ve Parola (Kullanıcı adı ve Şifre) BOTAŞ Doğalgaz İşletmeleri Bölge Müdürlüğü tarafından gereken yasal süreci tamamlayan şirketlere elden teslim edilmektedir. Konu ile ilgili detaylı bilgi için (312) 297 36 00 telefon numarasından Gaz İletim Müdürlüğü Yetkilileri ile görüşülebilir. Web Servislerine Şifre Gönderilmesi WCF (Windows Communication Service) transport level message security, ServiceCredentials X509Certificate, kullanılarak kullanıcı adı ve şifre doğrulama gerçekleştirilmektedir. 3. Süreçler ve Metotlar Bu bölümde EBT Sistemine veri gönderebilmek için kullanılacak web servis metotları açıklanmaktadır. Web Servis Metotları aşağıdaki gibidir: ANLIK AKIŞ ANLIKAKISGONDER Sayfa 2 / 10
TOPLUANLIKAKISGONDER SAATLİK AKIŞ SAATLIKAKISGONDER GÜNLÜK AKIŞ GUNSONUAKISGONDER NOKTA BELİRLEME NOKTALARIGETIR 4. Web Servis Metotları Detay Açıklamaları Bu bölümde EBT Web Servis metotlarının giriş ve çıkış parametreleri açıklanmaktadır. 4.1. Anlık Metotları 4.1.1. ANLIKAKISGONDER METODU Anlık verilerinin gönderildiği metottur. Metot Adı Giriş Parametresi Çıkış Parametresi ANLIKAKISGONDER EBTANLIKAKISDVO ANLIKAKISSONUCDVO Tablo 4.1.1.a: EBTANLIKAKISDVO Özellik Adı KURUMKODU Açık Adı Kurum Kodu Tipi Uzunluk Zorunlu Açıklama string 32 Evet Kurumunuza ait kurum kodunuzu ifade eder. NOKTAKODU Nokta Kodu string 32 Evet Verisi gönderilen noktanın EBT sistemindeki kodunu ifade eder. OLCUMZAMANI Ölçüm Zaman ı DateTime Evet Ölçümün yapıldığı tarihsaati (dd.mm.yyyy hh:mm:ss) ifade eder. ANLIKAKIS_STDM3_PERHOUR Anlık decimal Evet Ölçüm zamanındaki akış hızını ifade eder. (Stdm3/saat) ANLIKKUMULATIFAKIS_STDM3 USTISILDEGER_KCAL_PER_SM3 Anlık Kümül atif Üst Isıl Değer decimal Evet Saat 08:00 den ölçüm zamanına kadar gerçekleşen toplam akışı ifade eder. (Stdm3) Decimal Evet (Kcal/Sm3) Sayfa 3 / 10
ENERJI_KCAL Enerji Decimal Evet Kcal BASINC_BARG Basınç decimal Evet Ölçüm zamanındaki istasyon giriş basıncını ifade eder. (BARG) SICAKLIK_C Sıcaklı k decimal Evet Ölçüm zamanındaki istasyon giriş sıcaklığını ifade eder. (C) Sayfa 4 / 10
Tablo 4.1.1.b: ANLIKAKISSONUCDVO Özellik Adı Açık Adı Tipi Uzunluk Açıklama ANLIKKOD ANLIK KOD string 32 Gönderdiğiniz verinin, EBT Sistemi tarafından üretilen, takip numarasıdır. HATAVAR HATAVAR Bool Gönderim işleminin sonucu. false ise gönderim işlemi başarılıdır. true ise gonderim işlemi hatalıdır. HATA HATA HATA Gönderim işleminin sonucu hatalı ise, HATAVAR özelliği true, hata kodu ve açıklaması verilir Bkz Tablo E 4.1.2. TOPLUANLIKAKISGONDER METODU Anlık Akis verilerinin toplu olarak gönderilebildiği metottur. Metot Adı Giriş Parametresi Çıkış Parametresi TOPLUANLIKAKISGONDER EBTANLIKAKISDVO[] Bkz. Tablo ANLIKAKISSONUCDVO[] Bkz. Tablo 4.1.1.a 4.1.1.b 4.2. Saatlik Metotları 4.2.1. SAATLIKAKISGONDER METODU Saatlik verilerinin gönderildiği mettottur. Metot Adı Giriş Parametresi Çıkış Parametresi SAATLIKAKISGONDER EBTSAATLIKAKISDVO SAATLIKAKISSONUCDVO Tablo 4.2.1.a: EBTSAATLIKAKISDVO Özellik Adı Açık Adı Tipi Uzunluk Zorunlu Açıklama KURUMKODU Kurum Kodu string 32 Evet Kurumunuza ait kurum kodunuzu ifade eder. NOKTAKODU Nokta Kodu string 32 Evet Verisi gönderilen noktanın EBT sistemindeki kodunu ifade eder. OLCUMZAMANI Ölçüm Zamanı DateTime Evet Ölçümün yapıldığı saat aralığını (dd.mm.yyyy hh:00:00) ifade eder. ÖR:19.07.2013 16:00:00 ÖLÇÜM ZAMANI (19.07.2013 15:00:00 İLE 19.07.2013 16:00:00) ARALIĞINI İFADE EDER Sayfa 5 / 10
KUMULATIFAKIS_STDM3 Kümülatif decimal Evet Ölçüm zamanındaki saatlik gerçekleşen toplam akışı ifade eder( Stdm3) USTISILDEGER_KCAL_PER_S M3 Üst Isıl Değer decimal Evet Kcal/Sm3 ENERJI_KCAL Kümülatif Enerji decimal Evet Ölçüm zamanındaki saatlik gerçekleşen toplam enerjiyi ifade eder(kcal) BASINC_BARG Basınç decimal Evet Ölçüm zamanındaki istasyonun ortalama giriş basıncını ifade eder (BARG) SICAKLIK_C Sıcaklık decimal Evet Ölçüm zamanındaki istasyonun ortalama giriş sıcaklığını ifade eder. (C) Tablo 4.2.1.b: SAATLIKAKISSONUCDVO Özellik Adı Açık Adı Tipi Uzunluk Açıklama SAATLIKKOD SAATLİK KOD string 32 Gönderdiğiniz verinin, EBT Sistemi tarafından üretilen, takip numarasıdır. HATAVAR HATAVAR Bool Gönderim işleminin sonucu. false ise gönderim işlemi başarılıdır. true ise gonderim işlemi hatalıdır. HATA HATA HATA Gönderim işleminin sonucu hatalı ise, HATAVAR özelliği true, hata kodu ve açıklaması verilir Bkz Tablo E Sayfa 6 / 10
4.3. Günlük Metotları 4.3.1. GUNSONUAKISGONDER METODU Günsonu akış verilerinin gönderildiği metottur. Metot Adı Giriş Parametresi Çıkış Parametresi GUNSONUAKISGONDER EBTGUNSONUKAKISDVO GUNSONUAKISSONUCDVO Tablo 4.3.1.a: EBTGUNSONUKAKISDVO Özellik Adı Açık Adı Tipi Uzunluk Zorunlu Açıklama KURUMKODU Kurum Kodu string 32 Evet Kurumunuza ait kurum kodunuzu ifade eder. NOKTAKODU Nokta Kodu string 32 Evet Verisi gönderilen noktanın EBT sistemindeki kodunu ifade eder. OLCUMZAMANI AKISTOPLAMI_STDM3 Ölçüm Zamanı Günsonu Toplamı DateTime Evet Ölçümün yapıldığı tarihi (dd.mm.yyyy) ifade eder. (SAAT 08:00 DEN BİR SONRAKİ GÜN SAAT 08.00 KADAR ) (DATE) decimal Evet İstasyonun günlük gerçekleşen toplam akışını ifade eder( Stdm3) ENERJITOPLAMI_KCAL Kümülatif Enerji decimal Evet İstasyonun günlük gerçekleşen toplam enerjisini ifade eder(kcal) USTISILDEGER_KCAL_PER_SM3 Üst Isıl Değer decimal Evet İstasyonun günlük ortalama üst ısıl değerini ifade eder.(kcal/sm3) ORTALAMABASINC_BARG ORTALAMASICAKLIK_C Ağırlıklı Ortalama Giriş Basıncı Ağırlıklı Ortalama Giriş Sıcaklığı decimal Evet İstasyonun günlük akış ağırlıklı ortalama giriş basıncını ifade eder (BARG) decimal Evet İstasyonun günlük akış ağırlıklı ortalama giriş sıcaklığını ifade eder. (C) Sayfa 7 / 10
Tablo 4.3.1.b: GUNSONUAKISSONUCDVO Özellik Adı Açık Adı Tipi Uzunluk Açıklama GUNSONUKOD GÜNSONU KOD string 32 Gönderdiğiniz verinin, EBT Sistemi tarafından üretilen, takip numarasıdır. HATAVAR HATAVAR Bool Gönderim işleminin sonucu. false ise gönderim işlemi başarılıdır. true ise gonderim işlemi hatalıdır. HATA HATA HATA Gönderim işleminin sonucu hatalı ise, HATAVAR özelliği true, hata kodu ve açıklaması verilir Bkz Tablo E Sayfa 8 / 10
4.4. Nokta Belirleme 4.4.1. NOKTALARIGETIR METODU İlgili Kurumun sorumlu olduğu ve sistemde kayıtlı olan noktaların bilgilerinin talep edildiği metottur. NOKTA array i döndürür. Metot adı Giriş Parametresi Çıkış Parametresi NOKTALARIGETIR KURUMKODU NOKTA[] Sayfa 9 / 10
Tablo E : HATA Özellik Adı Açık Adı Tipi Uzunluk Açıklama KOD HATA KODU string İşlemin başarısız olması durumunda işleme göre üretilen hata kodudur. ACIKLAMA HATAVAR Bool İşlemin başarısız olması durumunda, oluşan hatanın detayıdır. 5. Sık Sorulan Sorular 5.1. EBT Web Servisleri gerçek ortam URL adresleri; http://ebtws.botas.gov.tr/krizma.botas.ebt.akis.svc 5.2. EBT Web Servisleri test ortam URL adresleri; http://ebtws.botas.gov.tr/krizma.botas.ebt.akis.svc 5.3. EBT Web Servislerini kullanmak için gerekli olan bilgiler nelerdir? KURUMKODU, KURUMPAROLA ve NOKTAKODLARI gerekmektedir. Bu bilgileri (Nokta Kodları Hariç) BOTAŞ Bilgi İşlem veya Gaz İletim Müdürlüğünden temin edebilirsiniz. ÖRNEK GÜN SONU AKIŞ CODE BİLGİSİ ebtservice.akisserviceclient c = new ebtservice.akisserviceclient(); c.clientcredentials.username.username = "KURUMKODU"; c.clientcredentials.username.password = "KURUMPAROLA"; c.clientcredentials.servicecertificate.authentication.certificatevalidationmode = System.ServiceModel.Security.X509CertificateValidationMode.None; ebtservice.ebtgunsonukakisdvo akis = new ebtservice.ebtgunsonukakisdvo(); akis.noktakodu = "NOKTAKODU"; akis.kurumkodu = "KURUMKODU"; akis.olcumzamani = Convert.ToDateTime("OLCUMZAMANI"); akis.akistoplami_stdm3 = (decimal) 10000000.12; akis.ortalamabasinc_barg = (decimal)123.15; akis.ortalamasicaklik_c = (Decimal)12.12; akis.ustisildeger_kcal_per_sm3 = (Decimal)8500.4548; akis.enerjitoplami_kcal=(decimal)85004549020,05; ebtservice.gunsonuakissonucdvo sonuc = null; try { sonuc = c.gunsonuakisgonder(akis); if (sonuc.hatavar == false) { string GUNSONUKOD = sonuc.gunsonukod; } } catch (Exception EX) { string hata = EX.ToString(); } Sayfa 10 / 10