Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Запрос:

URL:

Запрос списка всех ссылок пользователя:

               GET https://api.url/v2.1/user/<user_id>/spectator

Запрос ссылки по id:

               GET https://api.url/v2.1/user/<user_id>/spectator/<spectator_id>


Доп. Заголовки:

If-Modified-Since - Если ранее уже запрашивался полный список ключей наблюдателей (ключи для удалённого доступа), то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

Accept - для указания формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

ИмяТипЗначение по умолничюОписание
page[offset]int0Пропустить несколько первых записей
page[limit]int100Количество объектов в выводе
fields[spectator]string

Фильтрация полей отображаемых в объектах наблюдателей.

прим:

Если в запросе задано fields[spectator]=Key

То ответ будет содержать только ключ доступа.

Параметры sort, include и filter (определённые в стандарте JSON API) в текущей версии api не поддерживаются. В случае их получения сервер будет возвращать ошибку 400.

Ответ:

       Ответ присылается в формате JSON API.

ПолеОписание
links

Поле links содержит ссылки на ресурсы доступные из данного ресурса

Минимально он должен содержать ссылку на текущий ресурс (self).

Если Все группы не удалось поместить в одном ответе то также будет содержаться

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами

meta

Содержит:

total_count - количество наблюдателей за объектами у пользователя

data

Содержит массив объектов ключей наблюдателей в формате JSON API.

Каждый объект содержит

ПолеТипОписание
idintИдентификатор ключа
typestringТип ресурса (всегда "spectator")
attributesobjectДанные объекта (см. Описание атрибутов группы)
relationshipsobject

Объекты с которыми связанна группа

В текущей версии содержит только Cars

Cars - массив ссылок на ТС

Описание атрибутов группы:

ПолеТипNullableОписание
AccessKeystringнетКлюч доступа
NotestringдаКомментарий к ключу.
ValidTilldatetimeдаДо какого времени действует ключ (Если ValidTill > NOW то ключ не действителен (NOW - текущее время)).
MapLinkstringнетСсылка на сайт с картой для данного ключа
DateOfCreationdatetimeнетДата создания ключа

Связанные объекты Групп:

ПолеТипОписание
Carsarray<car_link>Массив ссылок на ТС которые доступны для просмотра по данному ключу

Коды ответов:

200 ОК - Сервер обработал запрос. В теле ответа  содержится список групп. Также будет передан заголовок Last-Modified.

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

401 Unauthorized - не передан заголовок Authorization, либо токен невалидный или окончилась валидация.

403 Forbidden - нет прав на просмотр (id пользователя не соответствует токену или запрошена ссылка , не принадлежащая пользователю).

404 Not Found - запрошенная ссылка не найдена .

400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).

Пример:

GET https://api.url/v2.1/user/1/spectator 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": "http://api.url/v2.1/user/1/spectator",
        "first": "https://api.url/v2.1/user/1/spectator",
        "next": "https://api.url/v2.1/user/1/spectator?page[offset]=100&page[limit]=100",
        "last": "https://api.url/v2.1/user/1/spectator?page[offset]=100&page[limit]=100"
    },
    "meta":{
        "total_count": 200
    },
    "data": [
        { "type": "spectator",
          "id": "1",
          "attributes": {
              "AccessKey": "THE_KEY",
              "Note": "just key, nothing special",
              "ValidTill": "2017-10-09T16:04:19Z",
              "MapLink": "http://map.url/?_cpKey=THE_KEY",
              "DateOfCreation": "2017-08-09T16:04:19Z"
          },
          "relationships":{
             "Cars": {
                "data": [
                    {"type": "car", "id":"1"},
                    {"type": "car", "id":"2"},
                    {"type": "car", "id":"3"},
                    {"type": "car", "id":"4"}
                ]
             }
          }
        },

         ... остальные ключи ...

    ]    
}	


Запрос ссылки по id:

GET https://api.url/v2.1/user/1/spectator/1 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/user/1/spectator/1",
    },
    "data": {
        { "type": "spectator",
          "id": "1",
          "attributes": {
              "AccessKey": "THE_KEY",
              "Note": "just key, nothing special",
              "ValidTill": "2017-10-09T16:04:19Z",
              "MapLink": "http://map.url/?_cpKey=THE_KEY",
              "DateOfCreation": "2017-08-09T16:04:19Z"
          },
          "relationships":{
             "Cars": {
                "data": [
                    {"type": "car", "id":"1"},
                    {"type": "car", "id":"2"},
                    {"type": "car", "id":"3"},
                    {"type": "car", "id":"4"}
                ]
             }
          }
        }     
    }   
}	
  • No labels