XML Post API
İleri tarihli olarak oluşturmuş olduğunuz SMS paketinin, iptal edilebilmesi için kullanılan metoddur. HTTP protokolünün POST metodunu kullanarak, XML formatında data göndererek kullanabilirsiniz.
İletimine başlanmış siparişler iptal edilemez.
İstek yapılacak adres
POSThttps://api.iletimerkezi.com/v1/cancel-order
İstek İçeriği (Body)
<request>
<authentication>
<key></key>
<hash></hash>
</authentication>
<order>
<id></id>
</order>
</request>
Tanımlar
Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir:
authentication
İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir:
key: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.
hash: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar ve Gizli Anahtar kullanılarak oluşturulmuş hash bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.
order
İptal edilecek SMS siparişi bilgisini içerir. Alt etiketi aşağıdaki gibidir
- id: Siparişi ifade eden eşsiz numerik değerdir. API üzerinden SMS gönderme isteği yaptığınızda size, sunucu tarafından dönen id değeridir. İstek yapılırken gönderilmesi zorunludur.
Sunucu yanıtı
<response>
<status>
<code>200</code>
<message>İşlem başarılı</message>
</status>
</response>
Tanımlar
Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketin alt etiketlerinin tanımı aşağıdaki gibidir:
status
İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir
- code: İşlem durumunu belirten numerik değerdir.
- message: İşlem durumu hakkında bilgi mesajı içerir.
Hata Kodları
Eğer istek sonucu olumsuz ise sunucu tarafından size dönücek hata kodları ve mesajlar aşağıdaki gibidir.
Hata Kodu | Mesaj | Açıklama |
---|---|---|
400 | İstek çözümlenemedi | POST ettiğiniz XML'in yapısındaki hatadan kaynaklanır. Bu hatalar genellikle, yanlış yazılan XML etiketi, düzgün kapatılmayan XML etiketi veya CDATA kullanılmadan XML'in yapısını bozabilecek bir karakterin kullanımından kaynaklanır. |
401 | Üyelik bilgileri hatalı | POST ettiğiniz XML'in authentication etiketi içerisinde göndermiş olduğunuz bilgileri doğrulayamadığımızda bu hatayı veriyoruz, eğer hesabınızda sabit IP tanımladıysanız ve farklı bir IP üzerinden istek yapıyorsanız yine bu hatayı alırsınız. |
404 | API istek yapılan yönteme sahip değil | Eğer bu hatayı alıyorsanız istek yaptığınız adresi tekrar kontrol edin yanlış bir adrese istek yapıyor olabilirsiniz. |
455 | Sipariş bulunamadı | İstek içerisinde iletmiş olduğunuz id ile oluşturulmuş bir sipariş yoksa veya sipariş gönderimi bekliyor durumundan iletiliyor durumuna geçti ise bu hatayı alırsınız. |
Örnek İstek
<?xml version="1.0" encoding="UTF-8" ?>
<request>
<authentication>
<key>demo</key>
<hash>demo</hash>
</authentication>
<order>
<id>428</id>
</order>
</request>
Örnek Başarılı Yanıt
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<code>200</code>
<message>İşlem başarılı</message>
</status>
</response>
Örnek Hatalı Yanıt
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<code>400</code>
<message>İstek çözümlenemedi</message>
</status>
</response>