WORKSECTION

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

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

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

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

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

Для использования API в нашем сервисе необходимо иметь API ключ. Доступ к API ключу есть только у владельца аккаунта и находится на странице Аккаунт -> Безопасность1 в блоке: Административное API


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

Есть самые необходимые функции, которые помогут Вам корректно вести свою деятельность, а именно:

— получение списка проектов, задач, подзадач, а так же списка временных и финансовых затрат;

— создание и закрытие задач, подзадач, размещение комментариев;

— подписка и отписывание участников;

— возможность приложения файлов.

Более детально с функциями Вы можете ознакомиться в документации.

Можно ли работать с Worksection через API?

Да, сейчас есть административный API
Доступ к api ключу есть только у владельца аккаунта и находится на странице Аккаунт /Безопасность.
Более детально с функциями вы можете ознакомиться в документации.

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

Для формирования GET или POST запросов в Worksection API используйте ссылку http://your-domain.com/api/admin/v2/,где your-domain.com – это адрес вашего аккаунта зарегистрированного в системе Worksection.

Запрос должен содержать в себе следующие параметры:

action - наименование действия
page - ссылка на проект, задачу или подзадачу из системы без имени самого аккаунта. Например:"/project/12345/"
hash - верификационная запись, сформированная в формате MD5 из трех связанных параметров: page, action и ваш apikey.

Владелец аккаунта может получить apikey в настройках аккаунта, раздел Безопасность в блоке Административное API



Пример структуры верификационной записи на языке программирования php:

$hash = md5($page.$action.$apikey)
Ответ сформирован в JSON формате, кодировка -  UTF-8
Поле статуса содержит информацию о статусе запроса:

ok – успешный запрос.
error – возникла ошибка

В случае, если статус запроса не соответствует ок, поля status_code and 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
  • 4 - Project is invalid
  • 5 - Task is invalid
  • 6 - Subtask is invalid
  • 3 - Page 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

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

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

{
"status": "error",
"status_code": 2,
"message": "Action hash is missed or invalid"
}
esc
или
Распечатать