Сервис предназначен для обеспечения перехода в облако из локального приложения.

Содержание

Публикация сервиса

Для использования сервиса в облаке должна быть выполнена публикация анонимного HTTP-сервиса МиграцияПриложений под пользователем с ролью "Удаленный доступ (миграция приложений)", путь публикации строго –  /info.

Пример vrd-файла публикации
<point
 base="/info"
 ib="Srvr=example.com;Ref=sm;Usr=migration;"
 xmlns="http://v8.1c.ru/8.2/virtual-resource-system"
 xmlns:xs="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <httpServices publishByDefault="false" publishExtensionsByDefault="false">
    <service
     rootUrl="migration"
     enable="true"
     reuseSessions="dontuse"
     sessionMaxAge="20"
     poolSize="10"
     poolTimeout="5"/>
  </httpServices>
</point>

Для проверки нужно использовать запрос GET https://example.com/info/hs/migration/info

Информация по настройкам регистрации

Возвращает информацию по доступным конфигурациям, контактным данным провайдера и точкам взаимодействия с сервисом.

Метод: GET /info

Поля ответа:

  • Enabled – Булево – миграция доступна
  • applications – Массив из Строка – список доступных конфигураций
  • url_recover – Строка – адрес страницы восстановления доступа
  • url_register – Строка – адрес страницы регистрации
  • url_api – Строка – адрес API Менеджера сервиса
  • url_adm – Строка – адрес личного кабинета
  • url_epf – Строка – адрес обработки перехода на сервере
  • provider_contacts – Структура – контакты провайдера (службы поддержки):
    • city – Строка – город
    • email – Строка – адрес электронной почты
    • site – Строка – сайт
    • phone – Строка – телефон
  • invitation_available – Булево – используются приглашения для регистрации
  • registration_available – Булево – доступна регистрация только по приглашениям для регистрации
  • support_companies_available – Булево – используются обслуживающие организации
  • support_companies_count – Число – количество доступных для выбора обслуживающих организаций
Пример запроса
GET https://example.com/info/hs/migration/info
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Enabled": true,
  "applications": [
    "Касса",
    "УправлениеНебольшойФирмой",
    "БиблиотекаТехнологииСервиса",
    "БухгалтерияПредприятияКОРП",
    "БухгалтерияПредприятияБазовая1"
  ],
  "url_recover": "https://example.com/recover",
  "url_register": "https://example.com/register",
  "url_api": "https://example.com/a/adm/hs/ext_api",
  "url_adm": "https://example.com/a/adm",
  "url_epf": "",
  "provider_contacts": {
    "city": "Москва",
    "email": "provider@example.com",
    "site": "https://example.com",
    "phone": "8(800)000-00-00"
  },
  "register_available": false,
  "invitation_available": true,
  "support_companies_available": true,
  "support_companies_count": 8
}

Критерии поиска

Возвращает список доступных критериев поиска обслуживающих организаций.

Метод: GET /search-terms

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – описание ошибки
  • searchTerms – Массив – критерии поиска
    • id – Строка –  идентификатор
    • name – Строка – наименование
    • description – Строка – описание
Пример запроса
GET https://example.com/info/hs/migration/search-terms
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": "",
  "searchTerms": [
    { "id": "all", "name": "Все партнеры", "description": "" },
    { "id": "city", "name": "По городу", "description": "" },
    { "id": "name", "name": "По наименованию", "description": "" }
  ]
}

Обслуживающие организации

Возвращает список обслуживающих организаций по критериям поиска.

Метод: GET /support-companies

Параметры запроса:

  • term – критерий поиска обслуживающей организации
  • value – значение критерия поиска

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – сообщение об ошибке
  • term – Строка – переданный критерий поиска
  • value – Строка – переданное значение критерия поиска
  • supportCompanies – Массив – найденные обслуживающие организации
    • id– Число – код абонента обслуживающей организации
    • name – Cтрока – наименование
    • city – Строка – город
    • email – Строка – почта
    • phone – Строка – телефон
Пример запроса
GET https://example.com/info/hs/migration/support-companies?term=city&value=Москва
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": "",
  "term": "city",
  "value": "Москва",
  "supportCompanies": [
    {
      "id": 1,
      "name": "Обслуживающая организация",
      "city": "Москва",
      "email": "support@example.com",
      "site": "https://example.com",
      "phone": "8(800)000-00-00"
    }
  ]
}

Проверка возможных вариантов загрузки приложения

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

Метод: GET /import-options

Параметры запроса:

  • name – имя конфигурации
  • version – версия конфигурации в формате a.b.x.y

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – описание ошибки
  • name – Строка – имя конфигурации
  • version – Строка – версия конфигурации
  • upload – Булево – доступна загрузка файла данных
  • upload_min_version – Строка – минимальная версия конфигурации для загрузки файла
  • upload_max_version – Строка – максимальная версия конфигурации для загрузки файла
  • migration – Булево – доступна миграция
  • migration_versions – Массив из Строка – массив доступных для миграции версий конфигураций.
Пример запроса
GET https://example.com/info/hs/migration/import-options?name=БиблиотекаТехнологииСервиса&version=2.1.1.19
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": "",
  "name": "БиблиотекаТехнологииСервиса",
  "version": "2.1.1.19",
  "upload": true,
  "upload_min_version": "2.1.1.15",
  "upload_max_version": "2.1.2.18",
  "migration": false,
  "migration_versions": [
    "2.1.2.18"
  ]
}

Проверка адреса электронной почты

Проверяет существование пользователя в сервисе по адресу электронной почты.

Метод: GET /email-available

Параметры запроса:

  • email – Строка – адрес электронной почты.

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – сообщение об ошибке
  • email – Строка – адрес электронной почты
Пример запроса
GET https://example.com/info/hs/migration/email-available?email=accountexample.com
Пример ответа
HTTP/1.1 400 Bad request
Content-Type: application/json; charset=utf-8

{
  "error": true,
  "description": "Указан некорректный адрес электронной почты.",
  "email": "accountexample.com"
}

Регистрация

Выполняет регистрацию пользователя по указанному типу регистрации.

Метод: POST /register

Параметры запроса:

  • type – Строка – тип регистрации. Возможные значения:
    • Invitation – приглашение для регистрации
    • Approval – запрос на регистрацию
    • Registration – ручная регистраци
  • login – Строка – логин
  • name – Строка – имя
  • password – Строка – пароль
  • email – Строка – почта
  • phone – Строка – телефон
  • code – Строка – (не обязательно) код активации. Используется, для получения информации из приглашения в сценарии активации приглашения
  • supportCompanyId – Число – (не обязательно) код обслуживающей организации (код абонента) используется для указания обслуживающей организации при регистрации. Если не указана, будет выбрана автоматически либо по коду приглашения, если он указан, либо по настройкам регистрации, если они указаны, либо будет назначен провайдер, если обслуживающие организации не используются.

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – сообщение об ошибке
Пример запроса
POST https://example.com/info/hs/migration/register
Content-Type: application/json; charset=utf-8

{  
  "type": "Invitation",
  "login": "account@example.com",
  "name": "account@example.com",
  "password": "123Qwer"
  "email": "account@example.com",
  "phone": "8(900)123-45-67"
}
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": ""
}

Информация по коду активации

Используется для заполнения данных регистрации по коду приглашения.

Метод: GET /reg-info

Поля запроса:

  • code - строка – код активации (код приглашения или код запроса на регистрацию)

Поля ответа:

  • error – Булево – признак ошибки
  • description – Строка – сообщение об ошибке
  • code – Строка – код активации, переданный в запросе
  • type – Строка – тип регистрации, возможные значения: Invitation – приглашение для регистрации, Approval – запрос на регистрацию
  • info– Информация по коду активации:
    • login – Строка – логин
    • name – Строка – имя
    • email – Строка – почта
    • phone – Строка – телефон
  • supportCompany – данные обслуживающей организации
    • id – Число – код абонента обслуживающей организации
    • name – Строка – наименование организации
    • city – Строка – город обслуживающей организации
    • email – Строка – почта
    • site – Строка – сайт
    • phone – Строка – телефон
Пример запроса
GET https://example.com/info/hs/migration/reg-info?code=12ec3343-a815-46d9-80b4-74024a79f8be
Пример ответа по коду
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": "",
  "code": "12ec3343-a815-46d9-80b4-74024a79f8be",
  "type": "Invitation",
  "info": {
     "login": "account@example.com",
     "name": "account@example.com",
     "email": "account@example.com",
     "phone": "8(900)123-45-67"
  },
  "supportCompany": {
     "id": 1,
     "name": "Обслуживающая организация",
     "city": "Москва",
     "email": "support@example.com",
     "site": "https://example.com",
     "phone": "8(800)000-00-00"
  }
}
Пример ответа, если данные по коду не найдены
HTTP/1.1 404 Not found
Content-Type: application/json; charset=utf-8

{
  "error": true,
  "description": "Не удалось найти информацию по коду '7570ca27-20f4-4237-af82-87195f556781'.",
  "code": "7570ca27-20f4-4237-af82-87195f556781"
}

Активация приглашения

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

Метод: POST /activation

Параметры запроса:

  • code – Строка – код приглашения для регистрации

Поля ответа

  • error – Булево – признак ошибки
  • description – Строка – сообщение об ошибке
  • login – Строка – при успешной активации возвращается логин пользователя.
Пример запроса
POST https://example.com/info/hs/migration/activation
Content-Type: application/json; charset=utf-8

{  
  "code": "7570ca27-20f4-4237-af82-87195f556781"
}
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "error": false,
  "description": "",
  "login": "account@example.com,
}