Для формирования GET или POST запросов в Worksection API используйте ссылку http://your-domain.com/api/admin/v2/, где your-domain.com – это адрес вашего Worksection аккаунта зарегистрированного в системе.
Запрос должен содержать в себе следующие параметры:
- action - наименование действия
- page - ссылка на проект, задачу или подзадачу из системы без имени самого аккаунта, например /project/12345/
- hash - верификационная запись, сформированная в формате MD5 из трех связанных параметров: page, action и ваш API key.
Владелец аккаунта может получить API key в Настройках аккаунта, раздел Безопасность в блоке Административное API
Пример структуры верификационной записи на php:
$hash = md5($page.$action.$apikey)
Ответ сформирован в
JSON формате, кодировка -
UTF-8Поле статуса содержит информацию о статусе запроса:
- ok – успешный запрос
- error – возникла ошибка
В случае, если статус запроса не соответствует
ок, поля
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
- 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
Пример ответа в случае успешного запроса{
"status": "ok"
}
Пример ответа в случае возникновения ошибки
{
"status": "error",
"status_code": 2,
"message": "Action hash is missed or invalid"
}
