JSON API

20,000.00

Модуль JSON API для интеграции OTRS любыми сторонними системами.

Расширенное JSON API для OTRS позволяет интегрировать с OTRS любые сторонние системы (например, мобильные приложения Android или iOS). В качестве механизмов взаимодействия используются HTTP GET запросы или HTTP POST запросы в формате JSON.

Методы:

  • Вход пользователя в OTRS
  • Выход пользователя из OTRS
  • Получение (смена) пароля пользователя в OTRS
  • Получение списка видов (фильтров) для выборки заявок
  • Получение списка заявок
  • Получение списка очередей
  • Получение списка сервисов
  • Получение списка SLA
  • Создание заявку
  • Обновление очереди заявки
  • Обновление сервиса заявки
  • Получение заметок заявки
  • Следить за заявкой
  • Пометить заявку как прочитанную
  • Пометить заметку как прочитанную
  • Получение списка видов (фильтров) для выборки заявок
  • очереди
  • Получение списка очередей
  • Получение списка сервисов
  • SLA
  • Получение списка SLA
  • Получение списка компаний
  • Получение списка клиентов
  • Получение информации по клиенту
  • Создание клиента
  • Создание заметки
  • Получение заметки заявки
  • Пометить заявку как прочитанную
  • Пометить заметку как прочитанную
  • Обновление очереди заявки
  • Обновление сервис заявки

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

 GET /otrs/api/auth/login?User=ivan&Password=13245

или в JSON формате:

 POST /otrs/api/auth/login

{

«User»    : «ivan»,

«Password» : «13245»

}

Для того, чтобы использовать функционал агентской части OTRS со стороны клиентского приложения, необходимо иметь учетные данные агента в системе OTRS, к которой будут посылаться запросы.

Для работы с запросами API необходимо получить специальный токен OTRSAgentInterface. Получение токена происходит с помощью метода /otrs/api/auth/login с логином и паролем агента. Имея данный токен можно воспользоваться функционалом всех остальных API методов, предоставляемых данным пакетом.

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

Раздел находится в процессе наполнения.

Установка пакета

Установка модуля осуществляется с помощью пакета RS4OTRS Advanced Escalation через стандартный функционал OTRS. Шаги установки пакета описаны в официальной инструкции OTRS 6 для Администратора на русском и английском языках.

Настройка

Настройка модуля в конфигурации системы производится в группе RS_API в подгруппах:

  • Color
  • Main
  • Test

 

5.1.1. Color

В данной группе задаются названия цветов для различных параметров заявок. Цвета заявок будут применены во внешней системе, с которой будет произведена интеграция посредством  API. Внешний вид подгруппы представлен на рисунке 5.1.

Рисунок 5.1. Внешний вид подгруппы Color

В подгруппе Color содержится 5 настроек:

  • RS::API::State::Color
  • RS::API::State::BackgroundColor
  • RS::API::Priority::Color
  • RS::API::Type::Color
  • RS::API::Type::BackgroundColor

 

5.1.1.1. RS::API::State::Color

В настройке задаются цвета для состояний заявок.

Поле Описание
Ключ Ключ цвета (название)
Содержание Html-код цвета
Ключ Содержание
DEFAULT #b3b3b3
new #ffffff
open #5bb8a5

 

5.1.1.2. RS::API::State::BackgroundColor

В настройке задаются цвета фона для состояний заявок.

Ключ Содержание
DEFAULT #ffffff
new #5bb8a5
open #ffffff

 

5.1.1.3. RS::API::Priority::Color

В настройке задаются цвета приоритетов заявок.

Ключ Содержание
1 very low #1e0000
2 low #b7b7b7
3 normal #5bb8a5
4 high #f9a46c
5 very high #f86868
DEFAULT #b3b3b3

 

5.1.1.4. RS::API::Type::Color

В настройке задаются цвета для типов заявок.

Ключ Содержание
DEFAULT #b3b3b3
Incident #5bb8a5
Problem #ffffff

 

5.1.1.5. RS::API::Type::BackgroundColor

В настройке задаются цвета фона для типов заявок.

Ключ Содержание
DEFAULT #b3b3b3
Incident #889988
Problem #eeeeee

 

5.1.2. Main

Внешний вид подгруппы представлен на рисунке 5.2.

Рисунок 5.2. Внешний вид подгруппы Main

В подгруппе содержатся настройки в которых задаются подключение для соответствующих методов:

  • Frontend::Module###API::Tickets
  • Frontend::Module###API::Settings
  • Frontend::Module###API::Filters
  • Frontend::Module###API::Queues
  • Frontend::Module###API::Services
  • Frontend::Module###API::Customers
  • Frontend::Module###API::Sla
  • Frontend::Module###API::Users

Настройка которая регулирует наличие номера заявки в теме:

  • RS::API::StripTicketNumberFromArticleSubject

Настройка задающая аббревиатуры для типов заметок

  • RS::API::Type::Abbr


Рисунок 5.3. Внешний вид подгруппы Test

 

5.1.3. Test

Внешний вид подгруппы представлен на рисунке 5.3. В подгруппе содержится настройка

RS::API::Test

Настройка необходима для процесса разработки. В настройке задается домен, пользователь и пароль. Должен быть указан логин существующего пользователя системы из группы “Пользователи”.

Поле Описание
Ключ Ключ настройки
Содержание Содержание настройки
Ключ Содержание
Domain Домен
Password Пароль пользователя
User Логин пользователя