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

Question

Accepted Answer

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

https://your-domain.worksection.com/api/admin/v2/?action=ACTION_NAME& PARAM_NAME1=PARAM_VALUE&...&PARAM_NAME_N=PARAM_VALUE&hash=HASH

your-domain.worksection.com — адреса вашого Worksection акаунту, зареєстрованого в системі

action — назва відповідного методу
PARAM_NAME — ряд назв параметрів відповідного методу (якщо потрібно)
hash — верифікаційний запис, сформований у форматі MD5 з кількох пов'язаних параметрів, action і вашого API key, розміщених один за іншим без відступів і строго в зазначеному порядку.

Приклад структури верифікаційного запису на php:

$hash = md5($.$action.$apikey)Важливо! Доступ до API можна отримати як через адмінський токен (API ключ), так і через користувацький токен без hash (OAuth2 токен).

Відповідь формується в 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

Колекції методів в Postman.