Начало работы с API

Для Вас, мы сделали инструкцию, разбитую по шагам, чтобы Вам было удобнее начать работу с нашим API!

Шаг 1. Важная информация для работы с API

Наш API работает на идеалогии REST, поэтому мы поддерживаем 4 основных метода:

GET - Для получения данных
POST - Для методов имеющих не идемпотентный результат выполнения
DELETE - Для удаления данных
PUT - Для методов имеющих идемпотентный результат выполнения

Требование к запросу API

При отправке POST, PUT, DELETE запросов обязателен заголовок Content-Type: application/json , а содержимое запроса должно находится в формате UTF8

Про идемподентность

Действие называется идемпотентным, если эффект от его однократного применения такой же, как и от многократного применения. Добавление продвижения будет не идемподентным методом, так как повторный его вызов создаст еще одно продвижение, в то время метод редактирования телефона будет идемподентен.

Шаг 2. Получение ключа и авторизация

Для работы с API необходимо получить API ключ, для этого необходимо послать запрос на /user/auth с вашим логином и паролем (описание метода есть на главной странице), в случае успеха Вы получите в заголовке X-SERVICE-KEY, который нужно будет передавать для любого запроса, связанного с пользовательскими действиями.

Шаг 3. Тестовые примеры

Тестовые примеры появятся в ближайшее время.

Шаг 4. Ответы API

200 - Запрос успешно обработан
201 - Успешное создание записи
400 - Переданнный запрос к API является некорректным и не содержит всех требуемых полей.
401 - Для доступа к методу требуется авторизация, возможно не был передан X-SERVICE-KEY.
403 - В запросе заполнены все необходимые поля, но параметры являются не корректными.
404 - API метод не найден
409 - При обновлении или добавлении записи произошел конфликт, возможно запись уже существует.
5xx - Критическая ошибка в нашем API.

Об отказе программного обеспечения и ошибке 500

Мы стараемся поддерживать максимальную стабильность нашего API, но любая техника ломается, происходят сбои. Из-за чего невозможно поддерживать 100% Uptime системы, но можно поддерживать близкое к этому значение.

500 код ответа приходит вам, если у нас появились проблемы на сервере. Обычно она сопровождается сообщением в формате JSON:

               {"error": "Were sorry, but something went wrong. We will been notified about this issue and well take a look at it shortly"}
               

При работе с нашим API, обязательно сделайте обработчик на данную ошибку, она возникает очень редко, но обрабатывать ее обязательно стоит. Если ваше приложение серверное, например синхронизирует задачи из нашего API, будет хорошим решением при данной ошибке запустить синхронизацию через какое-то время, например 5 минут. Обычно, этого времени достаточно на устранение проблемы.

При появлении данной ошибки, мы моментально узнаем о ней, чтобы приступить к ее устранению.

Шаг 5. Остались вопросы?

Будем рады их услышать по контактам предоствленным на нашем сайте