Инструкция пользователя для проекта HelpDeskPro

HelpDeskPro предлагает несколько тарифных планов, которые подойдут для организаций любого размера. Выберите подходящий тариф в зависимости от ваших потребностей.

1. Откройте веб-браузер и перейдите на страницу регистрации HelpDeskPro.
2. Заполните форму регистрации, указав имя, email и пароль.
3. Нажмите кнопку "Зарегистрироваться".
4. После успешной регистрации вы будете перенаправлены на страницу входа.

1. Войдите в систему HelpDeskPro.
2. Перейдите в раздел "Организации" в меню навигации.
3. Нажмите кнопку "Добавить организацию".
4. Заполните форму добавления организации, указав название.
5. Нажмите кнопку "Создать", чтобы сохранить организацию.

1. Перейдите в раздел "Категории" в меню навигации.
2. Нажмите кнопку "Добавить категорию".
3. Заполните форму добавления категории, указав название и родительскую категорию (если есть).
4. Нажмите кнопку "Создать", чтобы сохранить категорию.

1. Перейдите в раздел "Пользователи" в меню навигации.
2. Нажмите кнопку "Добавить пользователя".
3. Заполните форму добавления пользователя email и роль в организации.
4. Нажмите кнопку "Создать", чтобы сохранить пользователя.
5. После этого новый добавленный пользователь должен использовать функцию "Забыли пароль/Сброс пароля" на странице входа. Пароль будет выслан на электронный адрес пользователя. Таким образом обеспечивается безопасность входа всех добавленных пользователей.

1. Перейдите в раздел "Пользователи" в меню навигации.
2. Найдите пользователя, которого вы хотите отредактировать, и нажмите кнопку "Edit".
3. Внесите необходимые изменения в форму редактирования.
4. Нажмите кнопку "Сохранить изменения", чтобы сохранить изменения.

1. Перейдите в раздел "API-ключи" в меню навигации.
2. Выберите пользователя, для которого вы хотите сгенерировать API-ключ.
3. Нажмите кнопку "Generate API Key".
4. Для удаления API-ключа найдите его в списке и нажмите кнопку "Delete".

1. Перейдите в раздел "Тикеты" в меню навигации.
2. Нажмите кнопку "Создать тикет".
3. Заполните форму создания тикета, указав тему, описание и приоритет.
4. Нажмите кнопку "Создать", чтобы сохранить тикет.

1. Откройте тикет, к которому вы хотите добавить комментарий.
2. Введите текст комментария в соответствующее поле.
3. Нажмите кнопку "Добавить комментарий", чтобы сохранить комментарий.

1. Откройте тикет, который вы хотите отредактировать.
2. Внесите необходимые изменения в поля статуса, дедлайна, приоритета, категории и назначенного пользователя.
3. Нажмите кнопку "Сохранить изменения", чтобы сохранить изменения.

Для авторизации в API используйте заголовок Authorization с вашим API-ключом в формате Bearer YOUR_API_KEY.

URL: http://localhost/public/api/index.php/create_ticket

Метод: POST

Пример запроса:

curl -X POST http://localhost/public/api/index.php/create_ticket \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -F "subject=Sample Ticket" \
     -F "description=This is a sample ticket description." \
     -F "priority=low"

URL: http://localhost/public/api/index.php/add_comment

Метод: POST

Пример запроса с файлом:

curl -X POST http://localhost/public/api/index.php/add_comment \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -F "ticket_id=1" \
     -F "comment=This is a sample comment." \
     -F "attachment=@/path/to/file.pdf"

Пример запроса без файла:

curl -X POST http://localhost/public/api/index.php/add_comment \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{
           "ticket_id": 1,
           "comment": "This is a sample comment."
         }'

URL: http://localhost/public/api/index.php/get_tickets?page=1&per_page=5

Метод: GET

Пример запроса:

curl -X GET "http://localhost/public/api/index.php/get_tickets?page=1&per_page=5" \
     -H "Authorization: Bearer YOUR_API_KEY"

URL: http://localhost/public/api/index.php/get_ticket?id=88&page=1&per_page=5

Метод: GET

Пример запроса:

curl -X GET "http://localhost/public/api/index.php/get_ticket?id=88&page=1&per_page=5" \
     -H "Authorization: Bearer YOUR_API_KEY"

URL: http://localhost/public/api/index.php/update_ticket?id=88

Метод: PATCH

Пример запроса:

curl -X PATCH "http://localhost/public/api/index.php/update_ticket?id=88" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{
           "status": "in_progress",
           "priority": "high",
           "deadline": "2023-12-31",
           "assigned_user_id": 22
         }'

URL: http://localhost/public/api/index.php/get_users

Метод: GET

Пример запроса:

curl -X GET "http://localhost/public/api/index.php/get_users" \
     -H "Authorization: Bearer YOUR_API_KEY"