JSON Post API
This API method is under development, there may be changes to it. Please contact your customer representative to access the API method.
Rehberinizdeki grup bilgisini, HTTP protokolünün POST metodunu kullanarak, JSON formatında almak için, aşağıdaki yönergeleri takip edebilirsiniz.
İstek yapılacak adres
POSThttps://api.iletimerkezi.com/v1/get-group/json
İstek İçeriği (Body)
{
"request": {
"authentication": {
"key": "",
"hash": ""
},
"group": {
"id": 5
}
}
}
Tanımlar
Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir:
authentication
Contains information about the transaction status. The values returned with this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned as standard in every request made. Its subtags are as follows
key: After logging into your iletimerkezi.com panel, the API Key that you can create from the settings section should be written in this field. It is mandatory to send it when making a request.
hash: After logging into your iletimerkezi.com panel, the hash created using the API Key and Secret Key, which you can create from the settings section, should be written in this field. It is mandatory to send it when making a request.
group
Alt etiketleri aşağıdaki gibidir.
- id: Grubun benzersiz nümerik id değerini içerir.
Sunucu yanıtı
{
"response": {
"status": {
"code": 200,
"message": "İşlem başarılı"
},
"group": {
"id": 97101,
"name": "Test 1",
"count": 1,
"children": [
{
"id": 97489,
"name": "Test 2",
"count": 2
}
]
}
}
}
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
Contains information about the transaction status. The values returned with this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned as standard in every request made. Its subtags are as follows
- code: It is a numeric value indicating the process status.
- message: Contains information message about the process status.
group
İşlem başarılı olarak tamamlandıysa, grubun bilgisini içerir. İşlem başarısızsa bu etiket döndürülmez. 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.
- id: Grubu temsil eden benzersiz değer.
- name: Grubun ismini içerir.
- count: Grup içindeki kişi sayısını gösterir
Hata Kodları
The following table lists the error codes that the API can return.
Error Code | Message | Description |
---|---|---|
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. |
463 | Böyle bir grup bulunamadı. | Parent etiketi içindeki group id değeri hatalı ise bu hatayı alırsınız. |