WORKSECTION

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

Есть ли у Вас АPI и для чего он нужен?

API (от англ. Application Program Interface) — это интерфейс прикладного программирования для интеграции одного программного обеспечения с другим.

Worksection API позволяет вам получить доступ к сервису и запросить/отослать данные с целью синхронного взаимодействия с другими программами.

Как получить доступ к API?

Для использования API необходимо иметь API ключ.

Аккаунт → Безопасность → Административное API →
→ Показать API ключ


Обратите внимание! Доступ к API ключу есть только у Владельца аккаунта!

Какие API функции есть в Worksection?

Представлены все основные возможности и функции, которые есть в самой системе, а именно:

По участникам и контактам:
  • создание команд для участников и папок для контактов
  • создание контактов
  • приглашение новых участников в аккаунт
  • получение списков команд, участников, контактов
  • добавление и исключение участников по проектам
  • подписка и отписка участников по заданиям

По заданиям и комментариям:
  • создание, редактирование, закрытие и повторное открытие заданий
  • получение данных по заданиям
  • получение списка:
  • всех заданий
  • заданий определенного проекта
  • заданий согласно параметрам поиска
  • создание и получение комментариев по заданиям
  • создание, установка и снятие статусов/меток по заданиям

По проектам:
  • создание, редактирование, архивирование и активирование проектов
  • создание папок
  • получение данных по проектам
  • получение списка проектов и папок
  • создание, установка и снятие проектных статусов/меток

По внесенным затратам и работе с таймерами:
  • создание, обновление и удаление временных и финансовых затрат
  • получение отдельных строк затрат и их суммы по проектам и отдельным заданиям
  • получение списка включенных таймеров участников
  • возможность остановить включенные таймеры участников

По файлам:
  • возможность прикреплять файлы к комментариям и описаниям проектов/задач в момент их создания, а также скачивать загруженные и прикрепленные файлы

Обратите внимание! Для сохранения информации была исключена возможность удаления большинства данных, а именно:
  • проектов/заданий/комментариев
  • участников/контактов
  • статусов/меток проектов/задач
  • загруженных и прикрепленных файлов

Основные принципы работы с API

Для формирования GET или POST запросов в Worksection API используйте ссылку

https://your-domain.worksection.com/api/admin/v2/?action=ACTION_NAME&
page=LINK_URL&PARAM_NAME1=PARAM_VALUE&...&PARAM_NAME_N=PARAM_VALUE&hash=HASH
  • your-domain.worksection.com — адрес вашего Worksection аккаунта, зарегистрированного в системе
  • action — название соответствующего метода
  • page — ссылка на проект, задачу или подзадачу из системы без имени самого аккаунта в виде:
    • /project/PROJECT_ID/ — для проекта
    /project/PROJECT_ID/TASK_ID/ — для задачи
    /project/PROJECT_ID/TASK_ID/SUBTASK_ID/ — для подзадачи и под-подзадачи 
    Указанные ссылки можно получить как непосредственно из адресной строки браузера, находясь на странице проекта или задачи/подзадачи, или скомпоновать их, получив соответствующие идентификаторы через следующие методы:
    id задачи/подзадачи можно получить через метод get_all_tasks
    id проекта можно получить через метод get_projects 
  • PARAM_NAME — ряд названий параметров соответствующего метода (если нужно)
  • hash — верификационная запись, сформированная в формате MD5 из трех связанных параметров: page, action и ваш API key, размещенных один за другим без пробелов и строго в указанном порядке.
Пример структуры верификационной записи на php:

$hash = md5($page.$action.$apikey)
Обратите внимание! В ряде методов параметр page не требуется или является не обязательным, что необходимо учитывать при формировании hash записи:

$hash = md5($action.$apikey)
Ответ сформирован в JSON формате, кодировка — UTF-8

Поле статуса содержит информацию о статусе запроса:
  • ok — успешный запрос
  • error — возникла ошибка

Пример ответа в случае успешного запроса

{
    "status": "ok"
}
Пример ответа в случае возникновения ошибки

{
    "status": "error",
    "status_code": 2,
    "message": "Action hash is missed or invalid"
}
В случае возникновения ошибки поля status_code и message будут содержать информацию об ошибке (в некоторых случаях будет дополнительное поле message_details с расширенными деталями ошибки).

Соответствие status_code / message:

// query errors or a verification 
  • 0 — Action is invalid
  • 1 — Action is required
  • 2 — Action hash is missed or invalid
// errors in the URL
  • 3 — Page is invalid
  • 4 — Project is invalid
  • 5 — Task is invalid
  • 6 — Subtask is invalid
  • 7 — Project is required
  • 8 — Task is required
  • 9 — Subtask is required
// other errors
  • 10 — Field is required, message_details contains the name of the field
  • 11 — Invalid email, message_details contains invalid email
  • 12 — Task is already closed
  • 13 — Task has children
  • 14 — Subtask is already closed
  • 15 — Subtask has children
  • •••
  • 20 — Quota exceeded


esc
или
Распечатать