Ana içeriğe geç

JSON 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.

Rehberinizde tanımlı olan grupların listesini, HTTP protokolünün POST methodunu kullanarak, XML formatında almak için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres​

POSThttps://api.iletimerkezi.com/v1/get-groups/json

İstek İçeriği (Body)​

Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği
{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    }
  }
}

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.

Sunucu yanıtı​

{
  "response": {
    "status": {
      "code": "",
      "message": ""
    },
    "groups": {
      "group": [
        {
          "id": "",
          "name": "",
          "count": "0",
        }, ...]
      }
  }
}

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.

groups​

İşlem başarılı olarak tamamlandıysa rehberinizde oluşturulan ana grupların bilgisini içerir. İşlem başarısızsa bu etiket döndürülmez. Alt etiketleri aşağıdaki gibidir.

  • group​

    Grubun bilgisini içerir. Tanımlı ana grup sayısı kadar tekrar eder. Alt etiketleri aşağıdaki gibidir.

    • id: Grubu temsil eden benzersiz değer.

    • name: Grubun ismini içerir.

    • count: Grup içindeki kişi sayısını gösterir.

    • children​

      Grubun alt gruplarının bilgisini içerir alt etiketleri aşağıdaki gibidir.

      • child​

        Grubun alt grubunun bilgilerini içerir, alt grup sayısı kadar tekrar eder. Alt etiketleri aşağıdaki gibidir.

        • id: Grubu temsil eden benzersiz değer.
        • name: Grubun ismini içerir.
        • count: Grup içindeki kişi sayısını gösterir