Общая информация:

  1. Использовать API можно только после регистрации
  2. Получить API ключ можно здесь (доступно только после авторизации и подтверждения почты), или в меню, во вкладке «Ваш API ключ»
Поля, возвращаемого json документа:
  • error - булевое поле, если false, то ошибки нет, если true, то есть ошибка
  • status_code - код ответа
  • object - поле, которое передается, если ошибки нет
    • type - тип объекта (task/label)
    • content - содержание задачи
  • error_messages - Сообщения ошибок

Работа с задачами:

Работа с одной задачей:

  1. Ссылка, по которой строятся запросы: https://sibenshtern.ru//api/‹ваш API ключ›/task/‹id задачи›
  2. Возможные методы запроса:
    • GET - не требуется аргументы. Возвращает задачу в виде json документа
    • PUT - обязательно требуется аргумент action, со значение change_status. Обновляет состояние задачи (выполнена или нет)

Работа с несколькими задачами:

  1. Ссылка, по которой строятся запросы: https://sibenshtern.ru//api/‹ваш API ключ›/tasks
  2. Возможные методы:
    • GET - не требуются аргументы. Возвращает все задачи пользователя.
    • POST - требуются следующие аргументы:
      1. title - название задачи
      2. marks - id меток. Передаются через ;. Метки с неправильным или с несуществующим id будут игнорироваться
      3. finish_date - дата выполнения задачи. Формат: день.месяц.год

Работа с метками:

Работа с одной меткой:

  1. Ссылка, по которой строятся запросы: https://sibenshtern.ru//api/‹ваш API ключ›/mark/‹id метки›
  2. Возможные методы запроса:
    • GET - не требуется аргументы. Возвращает метку в виде json документа
    • PUT - обязательно требуется аргумент title.

Работа с несколькими марками:

  1. Ссылка, по которой строятся запросы: https://sibenshtern.ru//api/‹ваш API ключ›/marks
  2. Возможные методы:
    • GET - не требуются аргументы. Возвращает все метки пользователя.
    • POST - требуется аргумент title