1. Giriş
kontorport.com kurumsal müşterilerine, kendilerine ait web sitelerinden mevcut site altyapısını kullanarak işlem yapabilmek 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.
2. API Adresi
Sitemizin sunduğu API için web adresi aşağıda belirtilmiştir:
http://www.kontorport.com/services/api.php
3. Veri Dönüş Formatları
İşlem sonuçları her işlem için 1(bir) satır olarak döner.
OK <Ek bilgi> şeklinde bir satır döndürülür.
ERR <hatakodu> <hataAçıklaması> şeklinde bir satır döndürülür.
4. İşlemler
Sitemizin sunduğu API üzerinden temel olarak 2 işlem yapılmaktadır.
4.1 Talimat Verme
Hesabınızı kullanarak içerik yükleme talimatı vermek için kullanılır.
Giriş Parametreleri:
| Parametre | Açıklama |
|---|---|
| pilotno | Hesaba ait pilot numara (10 haneli olmalıdır) |
| sifre | Hesap Şifresi |
| islem | talimat |
| takipno | Talimat takibi için kullanılacak takip numarası. Kendi sisteminizde oluşturulan tekil numara gönderilmelidir. |
| icerik | kontor |
| tip | tam - parca |
| operator |
turkcell
vodafone
avea
turkcellses
turkcell3gcep
aveases
vodafoneses
avea3gcep
aveayd
aveasms
pubg
bimcell
pttcell
Önemli: Operator değeri site sahibi tarafından belirtilenlerden farklı bir hedef olarak da tanımlanabilir. |
| kontor | Yüklenmek istenen kredi miktarı |
| numara | Kredi yüklenecek telefon numarası (10 haneli olmalıdır) |
Dönüş Parametreleri:
OK
ERR <hata kodu> <hata açıklaması>
Örnek İşlem:
http://www.kontorport.com/services/api.php?pilotno=5111234567&sifre=1&islem=talimat&icerik=kontor&tip= tam&operator=avea&kontor=5&numara=5111234567&takipno=15468
OK
ERR 14 Kontor yüklenemedi!
4.2 Talimat Takibi
Talimat Verme işlemi ile hesabınız üzerinden verilen talimatların durumunu takip etmek için kullanılır.
Giriş Parametreleri
| Parametre | Açıklama |
|---|---|
| pilotno | Hesaba ait pilot numara (10 haneli olmalıdır) |
| sifre | Hesap Şifresi |
| islem | takip |
| takipno | Talimat takibi için kullanılan takip numarası. |
Talimat Durum Kodları:
| Parametre | AÇIKLAMA |
|---|---|
| 1 | Kontör Yüklendi |
| 2 | Beklemede |
| 3 | <Hata Mesajı> |
Dönüş Parametreleri:
OK <talimat durum kodu> <talimat durum açıklaması>
ERR <hata kodu> <hata açıklaması>
Örnek İşlem:
http://www.kontorport.com/services/api.php?pilotno=5111234567&sifre=1&islem=takip&takipno=15468
OK 1 Kontor Yüklendi
ERR 04 Geçersiz takip numarası!
4.3 Kredi Sorgulama
Kredi Sorgulama hesabınızda ne kadar kredi bulunduğunu sorgulamak için kullanılır.
Giriş Parametreleri
| Parametre | Açıklama |
|---|---|
| pilotno | Hesaba ait pilot numara (10 haneli olmalıdır) |
| sifre | Hesap Şifresi |
| islem | kredi |
Dönüş Parametreleri:
OK <kredi miktarı>
ERR <hata kodu> <hata açıklaması>
Örnek İşlem:
http://www.kontorport.com/services//api.php?pilotno=5111234567&sifre=1&islem=kredi
OK 0.00
ERR 01 Eksik Paramatre!
5. Hata Kodları
Api sistemimizde kullanılan hata kodları aşağıda listelenmiştir.
| Parametre | Açıklama |
|---|---|
| 01 | Eksik parametre |
| 02 | Hatalı Bayi Kodu - Pilot No - Şifre |
| 03 | Geçersiz İşlem Parametresi |
| 04 | Geçersiz Takip Numarası |
| 05 | Geçersiz İçerik Parametresi |
| 06 | Geçersiz Tip Parametresi |
| 07 | Geçersiz Operatör Parametresi |
| 08 | Geçersiz Numara Parametresi |
| 09 | Geçersiz Takip Numarası |
| 10 | İstediğiniz Kontör Seçtiğiniz Operatöre Yüklenemez |
| 11 | Sistem Bakım Çalışması. Lütfen daha sonra tekrar deneyiniz. |
| 12 | Yetersiz Limit |
| 13 | Provizyon Alınamadı |
| 14 | Kontör Yüklenemedi |