Запрос:
URL:
Запрос списка всех датчиков:
GET https://api.url/v2.1/currencies
Запрос датчика по id
GET https://api.url/v2.1/currencies/<currency_id>
Доп. Параметры запроса:
Поддерживаются стандартные параметры запроса page, sort, filter, fields.
Доп. Заголовки:
If-Modified-Since - Если ранее уже запрашивался полный список нименований валют, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified
Accept - для указания формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".
Authorization - для передачи токена. Передается в формате: Bearer <access_token>.
Ответ:
Ответ присылается в формате JSON API.
Поле | Описание | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
links | Поле links содержит ссылку на текущий ресурс (self). | ||||||||||||
meta | Содержит total_count - количество нименований валют в системе | ||||||||||||
data | Сожерит массив объектов Валюта в формате JSON API. Каждый объект датчиков содержит
|
Описание атрибутов:
Поле | Тип | Nullable | Описание |
---|---|---|---|
Name | string | false | Название валюты |
Коды ответов:
200 ОК - Сервер обработал запрос. В теле ответа содержится список наименований валюты. Также будет передан заголовок Last-Modified.
304 Not Modified - Сервер обработал запрос. Изменения не найдены.
401 Unauthorized - не передан заголовок Authorization, либо токен невалидный или окончилась валидация.
403 Forbidden - нет прав на просмотр (id пользователя не соответствует токену ).
404 Not Found - запрошенный датчик не найдена .
400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).
Пример:
Запрос списка всех датчиков:
GET https://api.url/v2.1/currencies HTTP/1.1 Accept: application/vnd.api+json HTTP/1.1 200 OK Content-Type: application/vnd.api+json Allow: GET Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT { "links": { "self": "https://api.url/v2.1/currencies" }, "meta": { "total_count": 5 }, "data": [ { "id": "1", "type": "currency", "attributes": { "Name": "lt" } }, { "id": "2", "type": "currency", "attributes": { "Name": "usd" } }, { "id": "3", "type": "currency", "attributes": { "Name": "руб" } }, { "id": "4", "type": "currency", "attributes": { "Name": "euro" } }, { "id": "5", "type": "currency", "attributes": { "Name": "Тенге" } } ] }