XML Post API

Uyarı

Bu API methodu geliştirme aşamasındadır, üstünde değişiklikler olabilir. API methoduna erişim için lütfen müşteri temsilciniz ile iletişime geçiniz.

Rehberinizdeki bir grubun bilgilerini, HTTP protokolünün POST metodunu kullanarak, XML formatında değiştirmek için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres

POSThttps://api.iletimerkezi.com/v1/edit-group

İstek İçeriği (Body)

<request>
  <authentication>
    <key></key>
    <hash></hash>
  </authentication>
  <group>
    <id></id>
    <name><![CDATA[...]]></name>
    <parent></parent>
  </group>
</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.

group

Düzenlenecek grup ile ilgili bilgileri içerir. Tekrar etmez. Alt etiketleri aşağıdaki gibidir.

• id: Düzenlenecek grubun benzersiz nümerik değerini içerir.
• name: Grubun yeni ismi.
• parent: Düzenlenen grup eğer alt grup ise, ana grubunun id değerini göndermeniz gerekmektedir, eğer oluşturduğunuz grup ana grup ise boş veya 0(sıfır) olarak göndermeniz gerekmektedir.

Sunucu yanıtı

<response>
  <status>
    <code></code>
    <message></message>
  </status>
  <group>
    <id></id>
    <name></name>
  </group>
</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.

group

• id: Düzenlenen grubun benzersiz nümerik değerini içerir.
• name: Düzenlenen grubun yeni ismini 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.
461	Grup adını boş bırakamazsınız.	Grup adı boş bırakıldığında bu hatayı alırsınız.
462	Grup id alanını boş bırakamazsınız.	Grup id alanındaki değeri boş veya hesabınızda tanımlı olmayan bir grup id değeri gönderdiğinizde bu hatayı alırsınız.
463	Böyle bir grup bulunamadı.	Parent etiketi içindeki group id değeri hatalı ise bu hatayı alırsınız.