WORKSECTION

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

Чи є у вас API та для чого він потрібен?

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

За допомогою API Worksection дозволяє вам отримати доступ до нашого сервісу та запросити/відіслати дані з метою синхронної взаємодії сервісу з іншими програмами.

Як отримати доступ до API?

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

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


Зверніть увагу! Доступ до API ключа є тільки у Власника акаунту!

Які функції наявні у Worksection API?

Наявні всі основні можливості та функції, які є в самій системі, а саме:

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

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

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

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

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

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

Основні принципи роботи з API

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

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 з трьох пов'язаних параметрів: pageaction і ваш 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 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
  • 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
или
Роздрукувати