WORKSECTION

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

Worksection АPI

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

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

Полезные материалы:
  1. Библиотека SDK для упрощения работы с нашим API. 
  2. Библиотека OAuth 2.0 для удобной работы с Worksection OAuth 2.0. 
  3. Коллекции методов в Postman.
Эта статья была вам полезна? Да, спасибо! Нет

Возможности Worksection API

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

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

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

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

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

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

Обратите внимание! Чтобы предотвратить потерю, случайное удаление или специальное уничтожение важных данных в системе отсутствует функционал удаления по API: 

  • проектов/​заданий/​комментариев
  • участников/​контактов
  • статусов/​меток проектов/​задач
  • загруженных и прикрепленных файлов
Эта статья была вам полезна? Да, спасибо! Нет

Авторизация для Worksection API

Доступ к Worksection API может осуществляться через:
  • админский токен
    *предоставляет максимальные права
  • пользовательский токен (oauth2 токен доступа)
    *предоставляет ограниченные права (согласно роли пользователя и разрешений приложения)

Админский токен

​​​Используется следующий базовый URL:
https://youraccount.worksection.com/api/admin/v2/
Админский токен формируется в формате MD5 из списка всех параметров, используемых в запросе, и административного API ключа аккаунта (см. пример ниже).

Пример для метода get_tasks
?action=get_tasks&id_project=26
Формирование токена (на PHP)
$query_params = 'action=get_tasks&id_project=26';
$api_key = '7776461cd931e7b1c8e9632ff8e979ce';

$hash = md5($query_params.$apikey);
Итоговый запрос
https://youraccount.worksection.com/api/admin/v2/?action=get_tasks&
id_project=26&hash=ec3ab2c28f21b4a07424f8ed688d6644

Пользовательский токен

*oauth2 токен доступа
​​
Используется следующий базовый URL:
https://youraccount.worksection.com/api/oauth2
Токен доступа можно сформировать через специальный запрос (см. детальнее). Действителен на протяжении 24-х часов. Далеe необходимо обновить его с помощью отдельного токена (refresh token) или сформировать новый.

Пример для метода get_tasks
?action=get_tasks&id_project=26
Итоговый запрос
*через header авторизации
curl -X GET -H "Authorization: Bearer <token_value>"
https://youraccount.worksection.com/api/oauth2?action=get_tasks&id_project=26
*через параметр access_token
https://youraccount.worksection.com/api/oauth2?action=get_tasks&id_project=26&
access_token=<token_value>
Эта статья была вам полезна? Да, спасибо! Нет

Получение административного API ключа

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


Аккаунт → API → Показать API ключ


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

Эта статья была вам полезна? Да, спасибо! Нет

Получение токена доступа OAuth 2.0

Данные для доступа можно получить путем исполнения POST-запроса на URL-адрес токена с кодом авторизации:

https://worksection.com/oauth2/token
POST-запрос должен содержать обязательные параметры:

ПАРАМЕТР
ОПИС
client_id
client_id, полученный при создании приложения.
client_secret
client_secret, полученный при создании приложения.
grant_type
Всегда указываем значения authorization_code.
code
Код авторизации (см. детальнее).
redirect_uri
URI, куда будет перенаправлен ответ. URI должен соответствовать требованиям стандарта OAuth2 и использовать протокол HTTPS.

Пример CURL:

curl -X POST -d "client_id=<client_id>&client_secret=<client_secret>&
grant_type=authorization_code&code=<authorization_code>&
redirect_uri=<redirect_uri>"
https://worksection.com/oauth2/token 
Пример ответа:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJh...",
    "refresh_token": "def502005534a202e9e8effa05cdbad564015604f34...",
    "account_url": "https://authorizeduseraccount.worksection.com"
}
Полученные access_token и refresh_token будем использовать в следующих запросах для доступа к API и обновления access_token. Срок действия access_token - 24 часа, срок действия refresh_token - 1 месяц.
Эта статья была вам полезна? Да, спасибо! Нет
Не работаем с московией. Слава Украине!
esc
или
Распечатать