Для формирования GET или POST запросов в Worksection API используйте ссылку
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/ — для подзадачи и под-подзадачи
Указанные ссылки можно получить как непосредственно из адресной строки браузера, находясь на странице проекта или задачи/подзадачи, или скомпоновать их, получив соответствующие идентификаторы через следующие методы:
- PARAM_NAME — ряд названий параметров соответствующего метода (если нужно)
- hash — верификационная запись, сформированная в формате MD5 из трех связанных параметров: page, action и ваш 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 и
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
- 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
