Ana içeriğe geç

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.

Rehberinize yeni bir grubu, HTTP protokolünün POST methodunu kullanarak, XML formatında oluşturmak için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres

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

İstek İçeriği (Body)

Eğer kullanıcı adı ve şifre kullanılarak işlem yapıyorsanız isteğin içeriği
<request>
<authentication>
<username></username>
<password></password>
</authentication>
<group>
<name><![CDATA[...]]></name>
<parent></parent>
</group>
</request>
Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği
<request>
<authentication>
<key></key>
<hash></hash>
</authentication>
<group>
<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:

  • username: iletimerkezi.com'a giriş yaparken kullanılan kullanıcı adıdır. Üye olurken kullanmış olduğunuz, cep telefonu numarasıdır. İstek yapılırken gönderilmesi zorunludur.
  • password iletimerkezi.com'a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi zorunludur.

group

Oluşturulacak grup ile ilgili bilgileri içerir. Alt etiketleri aşağıdaki gibidir.

  • name: Oluşturulacak grubun ismini içerir.
  • parent: Oluşturulacak grup eğer bir grubun alt grubu ise, o grubun id değerini göndermeniz gerekmektedir, eğer oluşturduğunuz grup ana grup ise boş 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

Grup bilgilerini ifade eder. Alt etiketleri aşağıdaki gibidir.

  • id: Oluşturulan grubun benzersiz değeri içerir.
  • name: Oluşturulan grubun ismini içerir.