Общая информация:
- Использовать API можно только после регистрации
- Получить API ключ можно здесь (доступно только после авторизации и подтверждения почты), или в меню, во вкладке «Ваш API ключ»
Поля, возвращаемого json документа:
error
- булевое поле, если false, то ошибки нет, если true, то есть ошибка
status_code
- код ответа
object
- поле, которое передается, если ошибки нет
type
- тип объекта (task/label)
content
- содержание задачи
error_messages
- Сообщения ошибок
Работа с задачами:
Работа с одной задачей:
- Ссылка, по которой строятся запросы:
https://sibenshtern.ru//api/‹ваш API ключ›/task/‹id задачи›
-
Возможные методы запроса:
- GET - не требуется аргументы. Возвращает задачу в виде json документа
- PUT - обязательно требуется аргумент
action
, со значение change_status
. Обновляет состояние задачи (выполнена или нет)
Работа с несколькими задачами:
- Ссылка, по которой строятся запросы:
https://sibenshtern.ru//api/‹ваш API ключ›/tasks
-
Возможные методы:
- GET - не требуются аргументы. Возвращает все задачи пользователя.
-
POST - требуются следующие аргументы:
title
- название задачи
marks
- id меток. Передаются через ;. Метки с неправильным или с несуществующим id будут игнорироваться
finish_date
- дата выполнения задачи. Формат: день.месяц.год
Работа с метками:
Работа с одной меткой:
- Ссылка, по которой строятся запросы:
https://sibenshtern.ru//api/‹ваш API ключ›/mark/‹id метки›
-
Возможные методы запроса:
- GET - не требуется аргументы. Возвращает метку в виде json документа
- PUT - обязательно требуется аргумент title.
Работа с несколькими марками:
- Ссылка, по которой строятся запросы:
https://sibenshtern.ru//api/‹ваш API ключ›/marks
-
Возможные методы:
- GET - не требуются аргументы. Возвращает все метки пользователя.
- POST - требуется аргумент
title