HTTP-сервис Tickets

Назначение сервиса

Сервис предназначен для получения одноразовых токенов аутентификации – тикетов Портала 1С:ИТС прикладными информационными базами облачного сервиса Фреш через обращения к Менеджеру Сервиса.

Адресация и аутентификация

Сервис вызывается по адресу: {BaseURL}/hs/tickets/

Где {BaseURL} – внутренний адрес Менеджера сервиса. Получить внутренний адрес можно вызовом функции:

РаботаВМоделиСервиса.ВнутреннийАдресМенеджераСервиса()

Метод запроса – POST. Параметры аутентификации приведены в таблице:

Параметр	Значение
Имя пользователя	`РаботаВМоделиСервиса.ИмяСлужебногоПользователяМенеджераСервиса()`
Пароль	`РаботаВМоделиСервиса.ПарольСлужебногоПользователяМенеджераСервиса()`

Передаваемые параметры

Параметры передаются в теле запроса в формате JSON. Параметры перечислены в таблице:

Параметр	Тип	Обязательный	Назначение
zone	Число	Да	Номер области, из которой осуществляется вызов сервиса. Получить номер области можно из параметра сеанса: `ОбластьДанныхЗначение`
zoneKey	Строка	Да	Ключ доступа области. Получить ключ доступа области можно из константы `КлючОбластиДанных` Константа может быть прочитана только в привилегированном режиме.
userGuid	Строка	Нет	Идентификатор пользователя сервиса. Если идентификатор не указан, пользователь сервиса будет определен по номеру области следующим образом (варианты перечислены в порядке перебора): Пользователь, который был создан при регистрации абонента-владельца области в документе `ПриглашениеДляРегистрации` и еще существует. Пользователь, который был создан при регистрации абонента-владельца области в документе `ЗапросНаРегистрацию` и еще существует. Пользователь абонента-владельца области с правами «Владелец абонента», который был создан раньше остальных.
openUrl	Строка	Нет	Адрес, на который необходимо осуществить переход на стороне 1С-Портала.

Пример тела запроса

{
  "zone": 261577,
  "zoneKey": "81356d85-82e3-44d9-9650-a0b2f3be9f05",
  "userGuid": "7d2f4726-9d27-427e-9d3e-307db44ad985",
  "openUrl": "https://1cfresh.com"
}

Ответы сервиса

В случае успешного получения тикета:

parameters - параметры запроса к Порталу
- subscriberCode - число - код абонента
- subscriberGuid - строка - уникальный идентификатор абонента
- userName - строка - логин пользователя
- userGuid - строка - идентификатор пользователя
ticket - строка - полученный тикет

Код состояния	Пример ответа
201: Created	`{` `"parameters": { "subscriberCode": 4707, "subscriberGuid": "767e446e-36b1-11ea-891e-0050568908e4", "userName": "123@123elper.ru", "userGuid": "767e446c-36b1-11ea-891e-0050568908e4" }, "ticket":"9a81b026-eac7-40ac-a774-da62d32a3c97" }`

В случае неудачного получения тикета возвращается JSON объект с текстом сообщения вида:

parameters - параметры запроса к Порталу
- subscriberCode - число - код абонента
- subscriberGuid - строка - уникальный идентификатор абонента
- userName - строка - логин пользователя
- userGuid - строка - идентификатор пользователя
text - строка - текст сообщения об ошибке

Пример ответа

{  
  "parameters": {
    "subscriberCode": 4707,
    "subscriberGuid": "767e446e-36b1-11ea-891e-0050568908e4",
    "userName": "123@123elper.ru",
    "userGuid": "767e446c-36b1-11ea-891e-0050568908e4"
  },
  "text":"[ТекстСообщения]"
}

Причина ошибки	Код состояния	Сообщения об ошибках
Не задан номер области	400: Bad request	Не задан номер приложения - zone
Некорректно задан номер области или область с указанным номером не найдена	400: Bad request	Некорректный номер приложения %zone%
Не задан ключ доступа области	400: Bad request	Не задан ключ доступа приложения - zoneKey
Некорректно задан ключ доступа области	400: Bad request	Некорректный ключ доступа приложения %zoneKey%
Некорректно задан идентификатор пользователя или пользователь с указанным идентификатором не найден	400: Bad request	Некорректный идентификатор пользователя %userGuid%
Передан пустой идентификатор	400: Bad request	Некорректный идентификатор пользователя %userGuid%
Пользователь не имеет прав на работу с приложением	400: Bad request	У пользователя нет доступа к приложению %zone%
Внутренняя ошибка при взаимодействии с Порталом	500: Internal server error	%ТекстИсключения%