Dokumentacja MAIL REST API 1.0

Parametry sterujące

Opis rozdziału

Na format odpowiedzi usługi API można wpłynąć przekazując w adresie URL dodatkowe parametry sterujące. Poniżej lista obsługiwanych parametrów.

envelope

domyślnie wyłączony
Domyślnie w ciele odpowiedzi zwracana jest tablica w formacie JSON, a status odpowiedzi (i ew. błędu) znajduje się w nagłówkach HTTP. Po włączeniu tej opcji ciało odpowiedzi opakowane jest dodatkową strukturą z dwoma parametrami, zawierającymi kod HTTP odpowiedzi oraz jej właściwą treść.
przykładowa odpowiedź prawidłowego zapytania:
a) parametr wyłączony
HTTP/1.1 200 OK
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache
Content-Length: 124
Content-Type: application/json

{
    "name":"alias",
    "domain":"demo.kei.pl",
    "email":"alias@demo.kei.pl",
    "target":"celprzekierowania@kei.pl"
}
b) parametr włączony
HTTP/1.1 200 OK
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache                                
Content-Length: 139
Content-Type: application/json

{
    "status": 200,
    "response": {
        "name":"alias",
        "domain":"demo.kei.pl",
        "email":"alias@demo.kei.pl",
        "target":"celprzekierowania@kei.pl"
    }
}
przykładowa odpowiedź błędnego zapytania:
a) parametr wyłączony
HTTP/1.1 500 Internal Server Error
Date: Wed, 26 Mar 2014 11:27:42 GMT
Server: Apache  
Content-Length: 110
Content-Type: application/json

{
    "code": "500.301"
    "message": "Nieprawidłowa nazwa aliasu pocztowego"
    "category": "validation"
}
b) parametr włączony
HTTP/1.1 200 OK
Date: Wed, 26 Mar 2014 11:27:42 GMT
Server: Apache  
Content-Length: 124
Content-Type: application/json

{
    "status": 500,
    "response": {
        "code": "500.301"
        "message": "Nieprawidłowa nazwa aliasu pocztowego"
        "category": "validation"
    }
}

callback/jsonpcallback/jsonp

domyślnie wyłączony
Jeżeli użytkownik chce korzystać z API używając JSONP, może przekazać ten argument aby wskazać nazwę funkcji callback dla JSONP, która ma zostać użyta w odpowiedzi.
przykładowa odpowiedź prawidłowego zapytania:
a) parametr wyłączony
HTTP/1.1 200 OK
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache                                
Content-Length: 124
Content-Type: application/json

{
    "name":"alias",
    "domain":"demo.kei.pl",
    "email":"alias@demo.kei.pl",
    "target":"celprzekierowania@kei.pl"
}
b) parametr włączony
HTTP/1.1 200 OK
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache                                
Content-Length: 196
Content-Type: application/json

myFunction({
    "status": 200,
    "response": {
        "name":"alias",
        "domain":"demo.kei.pl",
        "email":"alias@demo.kei.pl",
        "target":"celprzekierowania@kei.pl"
    }
});
przykładowa odpowiedź błędnego zapytania:
a) parametr wyłączony
HTTP/1.1 500 Internal Server Error
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache                                
Content-Length: 110
Content-Type: application/json

{
    "code": "500.301"
    "message": "Nieprawidłowa nazwa aliasu pocztowego"
    "category": "validation"
}
b) parametr włączony
HTTP/1.1 200 OK
Date: Tue, 01 Apr 2014 07:04:55 GMT
Server: Apache                                
Content-Length: 196
Content-Type: application/json

myFunction({
    "status": 500,
    "response": {
        "code": "500.301"
        "message": "Nieprawidłowa nazwa aliasu pocztowego"
        "category": "validation"
    }
});

pretty

domyślnie włączony
Ten parametr określa czy odpowiedź ma być sformatowana w sposób wygodny do czytania.
przykładowa odpowiedź:
a) parametr wyłączony
{     "name":"alias",     "domain":"demo.kei.pl",     "email":"alias@demo.kei.pl",     "target":"celprzekierowania@kei.pl" }
b) parametr włączony
{
    "name":"alias",
    "domain":"demo.kei.pl",
    "email":"alias@demo.kei.pl",
    "target":"celprzekierowania@kei.pl"
}