GELİŞTİRİCİ KONSOLU v2.0

Yanıt Yapısı

Organik API, verdiği yanıtların tipini belirlemenize olanak sağlar. İstek Yapısı bölümünde anlatılan bilgiler doğrultusunda API'nin verdiği yanıt bloğu ve içeriği, tip bazlı olarak aşağıda anlatılmıştır.

  • Response Headers:
    Method:       POST
    Status:       200 OK
    Host:         organikapi.com
    Content-Type: application/json
    Form Data:
    {
        "response": {
            "result": Boolean,
            "data": {...},
            "error": {
                "message": String,
                "number": String,
                "time": Date,
                "code": Int
            }
        }
    }
  • Response Headers:
    Method:       POST
    Status:       200 OK
    Host:         organikapi.com
    Content-Type: application/xml
    Form Data:
    <?xml version="1.0" encoding="UTF-8"?>
    <response>
    	<result>Int</result>
    	<data>...</data>
    	<error>
    		<message>String</message>
    		<number>String</number>
    		<time>Date</time>
    		<code>Int</code>
    	</error>
    </response>
Node Tip Açıklama
response Node Yanıt gövdesinin ilk elemanıdır.
result Boolean / Int Yanıt işleminin durumunu belirtir. true / false değerlerini alır. Başarılı işlemlerde hemen arkasından yanı verilerinin olduğu data bloğu gelir ve error bloğu gönderilmez, başarısız işlemlerde ise tam tersi olacak şekilde data bloğu gönderilmez ancak error bloğu gönderilir. XML yanıt gövdelerinde bu değer Int olur ve 0 / 1 değerlerini alır.
data Node Yanıt işleminin içeriğini barındırır. API'den talep edilen işleme göre içeriği değişir. Ancak API'den dönen tüm reel veriler bu bölüm içinde sunulur. Başarısız işlemlerin yanıt gövdesinde yer almaz.
error Node Bu bölüm sadece başarısız işlemlerde gönderilir. Hata mesajı, numarası, kodu ve zamanı bilgilerini içerir. Hata kodları ve anlamlarını Hata Kodları bölümünde bulabilirsiniz.
Organik API'yi kullanarak SMS gönderimi yapabilmeniz için aboneliğinizin olması gerekmektedir. Eğer aboneliğiniz yoksa buraya tıklayarak ücretsiz aboneliğinizi hızlı bir şekilde başlatabilirsiniz.