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.

Rehberinizdeki kişileri, HTTP protokolünün POST metodunu kullanarak, JSON formatında aramak için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres

POSThttps://api.iletimerkezi.com/v1/search-contacts/json

İstek İçeriği (Body)

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "search": {
      "key": "",
      "page": 1,
      "rowCount": 10
    }
  }
}

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.

search

Arama kriterlerini içerir. Tekrar etmez. Alt etiketleri aşağıdaki gibidir.

• key: Arama yapılacak değeri gösterir, rehberinizdeki telefon numarası, isim, soyad ve email adresleri alanları içinde arama yapar.
• page: Arama sonuç sayfasını ifade eder. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1’dir.
• rowCount: Bir arama sonuç sayfasındaki kişi adedini belirtir. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1000’dir. Maksimum değeri 1000’dir. Eğer 1000’den fazla kişi varsa ayrı bir istek ile diğer arama sonuç sayfaları sorgulanmalıdır.

Sunucu yanıtı

{
  "response": {
    "status": {
      "code": "",
      "message": ""
    },
    "contacts": [
      {
        "id": "",
        "name": "",
        "surname": "",
        "email": "",
        "gsm": "",
        "custom_fields": [
          {
            "id": "",
            "value": ""
          }
        ],
        "groups": [5]
      }
    ]
  }
}

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

Grubun içindeki kişilerin bilgisini içerir. 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.

• id: Rehber alanını temsil eden benzersiz nümerik değer.

• value: Rehber alanında kişi için tutulan değeri ifade eder.

• groups

Kişinin dahil olduğu grupları temsil eden benzersiz nümerik değerleri içerir. Alt etiketleri aşağıdaki gibidir.

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 JSON'in yapısındaki hatadan kaynaklanır. Bu hatalar genellikle, yanlış yazılan JSON etiketi, düzgün kapatılmayan XML etiketi veya CDATA kullanılmadan JSON'in yapısını bozabilecek bir karakterin kullanımından kaynaklanır.
401	Üyelik bilgileri hatalı	POST ettiğiniz JSON'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.
465	Kişi bulunamadı.	Eğer grup içerisinde herhangi bir kişi bulunamadıysa bu hatayı alırsınız.
471	Arama terimi en az 3 karakter olmalıdır.	Arama yaparken en az 3 karakterlik bir kelime girmeniz gerekmektedir.