- API работает по протоколу HTTPS, путем выполнения
POST— иGET-запросов - Авторизация происходит по токену (Api Key), ключ выдается по запросу. Так же в каждом запросе, необходимо передавать идентификатор базы данных (DB).
Api Key передается метдом get (api_key=’………….’)
DB передается метдом get (db=’………….’) - Все данные доступны только в формате JSON.
- Базовый URL: https://api.discurs.tech
- Запросы к данным могут отправляться из любой системы.
Синтаксис запроса
Чтобы обратиться к методу API, следует выполнить запрос следующего вида:
http://api.discurs.tech/api/METHOD_NAME?db=SELECT_DB&api_key=YOUR_API_KEY
| METHOD_NAME | Название метода API к которому идет обращение.add — добавить list — список | обязательно |
| YOUR_API_KEY | API ключ доступа | обязательно |
| SELECT_DB | Название базы данных | обязательно |
Формат ответа
{
«status»:»STATUS_IDENTITY»,
«message»:»MESSAGE»
}
METHOD list
- department — Список департаментов
- locations — Список локаций
- importance — Список важности
- tema — Список тем
- employ — Список сотрудников
- author — Список авторов
- address — Выпадающий список адресов. Пример запроса https://api.discurs.tech/address/?db=SELECT_DB&api_key=YOUR_API_KEY&adr=
GET Департаменты (list)
Пример запроса:
https://api.discurs.tech/list/department?db=&api_key=YOUR_API_KEY
Ответ:
{
«id» : «Уникальный идентификатор»,
«name» : «Название»
}
| id | ID |
| name | Название |
GET Локации (list)
Пример запроса:
https://api.discurs.tech/list/locations?db=&api_key=YOUR_API_KEY
Ответ:
{
«id» : «Уникальный идентификатор»,
«name» : «Название»
}
| id | ID |
| name | Название |
GET Важность (list)
Пример запроса:
https://api.discurs.tech/list/importance?db=&api_key=YOUR_API_KEY
Ответ:
{
«id» : «Уникальный идентификатор»,
«name» : «Название»
}
| id | ID |
| name | Название |
GET Темы (list)
Пример запроса:
https://api.discurs.tech/list/tema?db=&api_key=YOUR_API_KEY
Ответ:
{
«id» : «Уникальный идентификатор»,
«name» : «Название»
}
| id | ID |
| name | Название |
GET Сотрудники список (list)
Пример запроса:
https://api.discurs.tech/list/employ?db=&api_key=YOUR_API_KEY
Ответ:
{
«id» : «Уникальный идентификатор»,
«name» : «Название»
}
| id | ID |
| name | ФИО |
GET Тикеты доступные для сотрудника (list)
Пример запроса:
https://api.discurs.tech/all_employe_incidents/id_сотрудника?db=&api_key=YOUR_API_KEY
GET Календарь
Получение событий календаря
Пример запроса:
GET Список авторов (list)
Пример запроса:
https://api.discurs.tech/list/author?db=&api_key=YOUR_API_KEY
Ответ:
| Параметр | Значение |
| id | ID темы |
| name | ФИО |
| author_id | ID автора |
POST ID сотрудника и департамента
Получение ID сотрудника и департамента к которому он относится.
Пример запроса:
https://api.discurs.tech/employ_id/?db=&api_key=YOUR_API_KEY
Запрос:
| Наименование | Значение | Обязательно |
| employ_login | Логин сотрудника | * |
| employ_password | Пароль сотрудника | * |
Ответ:
| Наименование | Значение |
| status | Код сервера |
| ID | ID сотрудника |
| department_id | ID департамента к которому он относится |
| message | Уведомление сервера |
POST Ответ сотрудника из бота на сайт
Пример запроса:
https://api.discurs.tech/reply_employ/?db=&api_key=YOUR_API_KEY
Запрос
| Параметр | Значение | Тип | Обязательно |
| employ_id | ID сотрудника | int | * |
| ticketId | ID инцидента | int | * |
| comment | Ответ сотрудника | string | * |
| state | Этап на который проходит данный инцидент | int | * |
Ответ
| Парметр | Значение |
| status | Статус сервера |
| ID | ID инцидента |
| message | Ответ сервера |
POST Создание инцидента
Пример запроса:
https://api.discurs.tech/add/ticket?db=&api_key=YOUR_API_KEY
Запрос
| Параметр | Значение | Тип | Обязательно |
| ticket | Текст инцидента | text | * |
| ticket_author | Автор инцидента | text | * |
| ticket_link | Ссылка ни инцидент | text | * |
| ticket_author_id | ID автора | int | |
| link_mo | Ссылка ВС | text | |
| number_mo | Номер МО | text | |
| location_id | ID локации | int | |
| department_id | ID департамента | int | |
| subdivision | ID подразделения | int | |
| depratment_control | ID департамента контроля | int | |
| subdivision_control | ID подразделения контроля | int | |
| importance_id | ID важности | int | |
| tema_id | ID темы | int | |
| group_tema | ID группы тем | int | |
| category_id | ID источника | int | |
| comment | Комменатрий к инциденту | text | |
| address | Адресс | text | |
| stage | ID этапа | int | |
| create_user | ID пользователя создавший инцидент | int | |
| employ | ID пользователя | int | |
| employ_control | ID пользователя контроля | int | |
| soemploy | Соисполнители | array | |
| community | Сообщество | text | |
| community_link | Ссылка на сообщество | text | |
| phone | Телефон | text | |
| tags | Теги | array |
Ответ
| Параметр | Значение |
| status | Статус сервера |
| ID | ID созданного инцидента |
| message | Ответ сервера |
POST Загрузка файла к обращению
Пример запроса:
https://api.discurs.tech/add/files?db=&api_key=YOUR_API_KEY
Запрос
| Параметр | Значение | Обязательно |
| ticketId | ID обращения | * |
| file | Название индекса | * |
Ответ
| Параметр | Значение |
| status | Статус сервера |
| ticketId | ID обращения |
| message | Ответ сервера |
POST Комментарии к обращению
Пример запроса:
https://api.discurs.tech/add/comment?db=&api_key=YOUR_API_KEY
Запрос:
| Параметр | Значение | Тип | Обязательно |
| ticketId | ID обращения | int | * |
| comment | Комментарий | string | * |
| comment_type | employ — комментарий сотрудника author — комментарий автора обращения | string | * |
| employ_id | ID сотрудника, если это комменатрий сторудника | int |
Ответ:
| Параметр | Значение |
| status | Статус сервера |
| ticketId | ID обращения |
| message | Ответ сервера |
POST Загрузка файла к комментарию
Пример запроса:
https://api.discurs.tech/add/files_comment?db=&api_key=YOUR_API_KEY
Запрос
| Параметр | Значение | Обязательно |
| commentId | ID комменатрия | * |
| file | Название индекса | * |
Ответ
| Параметр | Значение |
| status | Статус сервера |
| ticketId | ID обращения |
| message | Ответ сервера |
POST Инциденты в работе
Пример запроса:
ttps://api.discurs.tech/ticket_work/?db=&api_key=YOUR_API_KEY
Список всех инцидентов со статусом в работе
Возможные ошибки
«status»: 501,
«message»: «База данных не определена»
«status»: 501,
«message»: «No api_key»