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, HTTP protokolünün POST methodunu kullanarak, XML formatında kişi eklemek için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres​

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

İ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>
  <contacts>
    <contact>
      <name><![CDATA[...]]></name>
      <surname><![CDATA[...]]></surname>
      <email><![CDATA[...]]></email>
      <gsm></gsm>
      <custom_fields>
        <custom_field>
          <id></id>
          <value></value>
        </custom_field>
      </custom_fields>
      <groups>
        <group>
          <id></id>
        </group>
      </groups>
    </contact>
  </contacts>
</request>
Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği
<request>
  <authentication>
    <key></key>
    <hash></hash>
  </authentication>
  <contacts>
    <contact>
      <name><![CDATA[...]]></name>
      <surname><![CDATA[...]]></surname>
      <email><![CDATA[...]]></email>
      <gsm></gsm>
      <custom_fields>
        <custom_field>
          <id></id>
          <value></value>
        </custom_field>
      </custom_fields>
      <groups>
        <group>
          <id></id>
        </group>
      </groups>
    </contact>
  </contacts>
</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.

contacts​

Grubun içindeki kişilerin bilgisini içerir. Alt etiketleri aşağıdaki gibidir.

  • contact​

    Kişi bilgisini içerir. Kişi sayısı kadar tekrar eder. Alt etiketleri aşağıdaki gibidir.

    • id: Kişiyi temsil eden benzersiz nümerik değeri ifade eder.

    • name: Kişi ismini ifade eder.

    • surname: Kişinin soyismini ifade eder.

    • email: Kişinin eposta adresini ifade eder.

    • gsm: Kişinin cep telefonu bilgisini ifade eder.

    • custom_fields​

      Kişi için tanımlanmış rehber alanlarını ifade eder. Alt etiketleri aşağıdaki gibidir.

      • custom_field​

        Kişi için tanımlanmış rehber alanını ifade eder. Tanımlanan alan kadar tekrar eder. Alt etiketleri aşağıdaki gibidir.

        • id: Rehber alanını temsil eden benzersiz nümerik değer.
        • value: Rehber alanında kişi için tutulan değeri ifade eder.
        • custom_field_settings: Rehber alanında kişi için tutulan değeri ifade eder.

    • groups​

      Kişinin dahil olduğu grupları içerir. Alt etiketleri aşağıdaki gibidir.

      • group: Kişinin dahil olduğu grubun bilgisini içerir. Dahil olduğu grup kadar tekrar eder.
      • id: Grubu temsil eden benzersiz nümerik değer.

Sunucu yanıtı​

<response>
  <status>
    <code></code>
    <message></message>
  </status>
  <contacts>
    <contact>
      <code></code>
      <message></message>
    </contact>
  </contacts>
</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.

contacts​

Rehbere eklenen kişilerin eklenme bilsini içerir. Alt etiketleri aşağıdaki gibidir.

  • contact​

    Eklenen kişinin eklenme bilgisini içerir. Alt etiketleri aşağıdaki gibidir:

    • code: İşlem durumunu belirten numerik değerdir.
    • message: İşlem durumu hakkında bilgi mesajı içerir.