API Desteği...
Hemenkontor.com
Kurumsal Üyeler için
Web API Kullanım Klavuzu
1. Web API hakkında
a. Giriş
hemenkontor.com kurumsal müşterilerine, kendilerine ait web sitelerinden mevcut site altyapısını kullanarak kontor yuklemek için web tabanlı çalışan bir API hizmeti sunmaktadır. Bu API sayesinde, belirtilen web adresine uygun formatta veri göndererek istenen işlemler gerçekleştirilebilecektir.
b. API adresi
Sitemizin sunduğu API için web adresi aşağıda belirtilmiştir.
http://www.hemenkontor.com/services/api.php
c. API İşlemleri
Sitemizin sunduğu API üzerinden temel olarak 2 işlem yapılmaktadır.
Talimat Verme: İstenilen kontörün yüklenmesi için sipariş verme
Talimat Takip: Kontor yüklenme durumunun sorgulanması
d. Veri dönüş formatı
İşlem sonuçları her işlem için 1 satır döndürülecektir.
Eğer işlem başarılı olmuşsa "OK <Ek bilgi>" şeklinde bir satır dönülürken
Başarısız olmuşsa "ERR <hatakodu> <hataAçıklaması>" şeklinde bir satır dönülür.
e. Hata Kodları
Api sistemimizde kullanılan hata kodları aşağıda listelenmiştir.
01 = "Eksik paramatre!",
02 = "Hatalı bayıkodu - pilotno - şifre!",
03 = "Geçersiz işlem parametresi!",
04 = "Geçersiz takip numarası!",
05 = "Geçersiz içerik parametresi!",
06 = "Geçersiz tip parametresi!",
07 = "Geçersiz operator parametresi!",
08 = "Geçersiz numara parametresi!",
09 = "Geçersiz takipno parametresi!",
10 = "İstediğiniz kontör seçtiğiniz operatore yuklenemez!",
11 = "Sistemde bakım çalışması var! Lütfen daha sonra tekrar deneyiniz!",
12 = "Sistemde bulunan limitiniz yeterli değil!",
13 = "Kontor yükleme için provizyon alınamadı!",
14 = "Kontor yüklenemedi!"
2. İşlem Listesi
Talimat Verme
Hesabınızı kullanarak içerik yükleme talimatı vermek için kullanılır.
Giriş Parametreleri:
pilotno: Hesabınızın pilot numarası (10 hane Örn 5421234567)
sifre: Hesabınızın şifresi
islem: talimat
takipno: Talimat takibi için kullanılacak takip numarası. Kendi sisteminizdeki tekil numara gönderilmelidir.
icerik: kontor
tip: tam - parca
operator: avea - turkcell - vodafone - vodafonecepog
kontor: Yüklenmek istenen kontor miktarı
numara: Kontörün yükleneceği telefon numarası. (10 hane Örn 5421234567)
Dönüş:
İşlem başarılı ise
OK
İşlem başarısız ise
ERR <hata kodu> <hata açıklaması>
Örnek:
http://www.hemenkontor.com/services/api.php?pilotno=5111234567&sifre=1&islem=talimat&icerik=kontor&tip=
tam&operator=avea&kontor=5&numara=5111234567&takipno=15468
Başarılı dönüş: OK
Başarısız dönüş: ERR 14 Kontor yüklenemedi!
Talimat Takibi
Talimat Verme işlemi ile hesabınız üzerinden verilen talimatların durumunu takip etmek için kullanılır.
Giriş Parametreleri:
pilotno: Hesabınızın pilot numarası (10 hane Örn 5421234567)
sifre: Hesabınızın şifresi
islem: takip
takipno: Talimat takibi için kullanılacak takip numarası. Kendi sisteminizdeki tekil numara gönderilmelidir.
Dönüş Parametreleri:
İşlem başarılı ise
OK <talimat durum kodu> <talimat durum açıklaması>
İşlem başarısız ise
ERR <hata kodu> <hata açıklaması>
Talimat durum kod ve açıklamaları
1 = Kontör yüklendi
2 = Beklemede
3 =
Örnek:
http://www.hemenkontor.com/services/api.php?pilotno=5111234567&sifre=1&islem=takip&takipno=15468
Başarılı dönüş:
OK 1 Kontor Yüklendi
OK 2 Beklemede
OK 3 Abone bulunamadı
Başarısız dönüş:
ERR 04 Geçersiz takip numarası!
Kredi Sorgulama
Kredi Sorgulama hesabınızda ne kadar kredi bulunduğunu sorgulamak için kullanılır.
Giriş Parametreleri:
pilotno: Hesabınızın pilot numarası (10 hane Örn 5421234567)
sifre: Hesabınızın şifresi
islem: kredi
Dönüş Parametreleri:
İşlem başarılı ise
OK <kredi miktarı>
İşlem başarısız ise
ERR <hata kodu> <hata açıklaması>
Örnek:
http://www.hemenkontor.com/services/api.php?pilotno=5111234567&sifre=1&islem=kredi
Başarılı dönüş:
OK 1045.65
Başarısız dönüş:
ERR 01 Eksik paramatre!