ДОКУМЕНТАЦИЯ К API

Информация

API Pointexpress позволяет подключиться к Pointexpress и создавать собственные приложения на базе сервиса.

API предоставляет простой ресурсо-ориентированный интерфейс REST с ответами в формате JSON для использования функций Pointexpress.

Весь доступ к API осуществляется через HTTPS и осуществляется из pointexpress.ru/api/. Все данные отправляются и принимаются в формате JSON.

Авторизация

Для идентификации в API используется специальный ключ доступа, который называется access_token. Токен — это строка из цифр и латинских букв, которую вы передаете на сервер вместе с запросом в заголовке. Из этой строки сервер получает всю нужную ему информацию. Получить access_token можно в личном кабинете.

Access_token необходимо передавать в заголовке:

X-Authorization: Bearer $ACCESS_TOKEN

Не сообщайте данный код посторонним лицам

Описание методов

addTrack - добавление трек кода

Добавление нового трек кода. Метод возвращает готовый идентификатор.

URL для запроса: https://pointexpress.ru/api/addTrack

Доступные параметры:

status	Первоначальный статус. При отсутствии статуса, будет добавлен статус по умолчанию (зависит от настроек пользователя).	Необязательный
description	описание трек кода, не раскрывающее персональных данных пользователя.	Необязательный
coords	координаты на карте текущего положения..	Необязательный

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/addTrack

GetTrackInfo - Получить полную информацию о трек коде

Получение полной информации о трек коде, включая список статусов

URL для запроса: https://pointexpress.ru/api/getTrackInfo

Доступные параметры:

code

Трек код

Обязательный

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/getTrackInfo?code=RU00D000016

GetTrackData - Получить трек код

Получение информации о трек коде: описание, координаты и т.п.

URL для запроса: https://pointexpress.ru/api/getTrackData

Доступные параметры:

code

Трек код

Обязательный

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/getTrackData?code=RU00D000016

AddTrackStatus - Получить трек код

Добавление нового статуса для трек кода. Осуществится проверка прав пользователя.

URL для запроса: https://pointexpress.ru/api/addTrackStatus

Доступные параметры:

code	Трек код. Осуществится проверка прав пользователя.	Обязательный
status	Текстовый статус	Обязательный

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/addTrackStatus?code=RU00D000016&status=Created

GetTrackStatus - получение статусов для трек кода

Получение списка статусов для трек кода

URL для запроса: https://pointexpress.ru/api/getTrackStatus

Доступные параметры:

code

Трек код.

Обязательный

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/getTrackStatus?code=RU00D000016

GetMyCodes - Получение своих трек кодов

Получение списка трек кодов авторизованного пользователя

URL для запроса: https://pointexpress.ru/api/getMyCodes

Доступные параметры отсутствуют

Пример запроса:

curl -i
    -X GET
    -H "X-Authorization: Bearer  $ACCESS_TOKEN"
    https://pointexpress.ru/api/getMyCodes

Коды ошибок

Возвращаемые коды ошибок

E1001	Ошибка авторизации
E1002	Отсутствуют обязательные параметры
E1003	Ошибка доступа
E1004	Не найдено
E1005	Токен запроса не передан или недействителен.
E1006	Невозможно отправить электронное письмо
E1007	Пользователь заблокирован
E1008	Сработал СТОП фильтр
E1009	Недостаточно средств
E1010	Неверный запрос