WORKSECTION

Початок роботи

Worksection API

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-х годин. Далі необхідно оновити його за допомогою окремого токену (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
или
Роздрукувати