Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Логування

Всі API вимагають логування. Більшість API працюють як при GET, так і POST запитах. Для детальнішої інформації слід переглянути опис конкретного API. Для коректного логування необхідно виконати логування за допомогою токена. Токен повинен бути переданий у запиті.

...

Якщо буде передано і параметр в запиті, і header - то враховувати буде саме header.

Приклад неправильної відповіді

Переданий неправильний токен

Code Block
languagejson
{
    "result": "okerror",
    "response": {
        "11111": {
            "geozones": [
                {
                    "geozoneID": -1,
                    "errorMessage": "Can`t find ['geozoneID'] at the item list"
                },
                {
                    "geozoneID": 555,
                    "errorMessage": "Wrong Timestamp"
                },
                {
                    "geozoneID": 666,
                    "errorMessage": "Can`t find ['start'] at the item list"
                }
            ]
        },
        "33333": {
            "errorMessage": "User has not permission on the object with ID [134]"
        },
        "22222": {
            "errorMessage": "Can`t find ['geozones'] at the item list"
        },
        "-1": {
            "errorMessage": "Can`t find ['deviceID'] at the item list"
        }
    }
}"Invalid token"
}

Не переданий токен

Code Block
languagejson
{
    "result": "error",
    "response": "Token param is empty"
}

Типи можливих помилок

Помилка

Пояснення

Can`t parse the parameter - [data]

не перeданий параметр [data]

Can`t find ['deviceID'] at the item list

не перeданий ключ [deviceID], “-1” замість ID пристрою у відповіді

User has not permission on the object with ID [33333]

нема доступу до об'єкту з ID [33333]

Can`t find ['geozones'] at the item list

не переданий ключ [geozones]

Can`t find ['geozoneID'] at the item list

не перeданий ключ [geozoneID]

Can`t find ['start'] at the item list

не переданий ключ [start]

Wrong Timestamp

неправильний формат дати: дата має бути у форматі timestamp (UTC), не раніше, ніж поточний рік і не пізніше 2000 року

Invalid token

переданий неправильний токен авторизації

Token param is empty

не перeданий параметр [auth_token] та відсутній header з токеном