Интерактивная регистрация в сервисе

Для интерактивной регистрации можно использовать HTTP-сервис внешней регистрации - ExternalRegistration. 

В интерактивном режиме сервис внешней регистрации работает совместно с сервисом быстрой регистрации -  FastExternalRegistration. 

Для регистрации в сервисе новых пользователей (владельцев новых абонентов) применяется метод register  HTTP-сервиса внешней регистрации (ExternalRegistration ).

Для вызова этого метода выполняется POST-запрос следующего вида:

Запрос

POST {baseURL}/a/extreg/hs/ExternalRegistration/register/
Content-Type: application/x-www-form-urlencoded
Accept: text/html

Здесь предполагается, что HTTP-сервис внешней регистрации ExternalRegistration опубликован с относительным адресом  /a/extreg

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

Дополнительные параметры при использовании промокодов

Дополнительные параметры при использовании защиты от автоматических действий

При использовании в сервисе защиты от автоматических действий среди параметров запроса к HTTP-сервису внешней регистрации может быть необходимо указывать параметр, значение которого возвращается сервисом проверки CAPTCHA (различения людей и роботов). Для сервиса Google reCAPTHA имя этого параметра  g-recaptcha-response . Без указания этого параметра в запросе к HTTP-сервису внешней регистрации в регистрации пользователя может быть отказано.

Также в запросе к HTTP-сервису внешней регистрации указывается адрес редиректа при определении что пользователь это робот.

Пример страницы для выполнения запроса

<form action="https://1cfresh.com/a/extreg/hs/ExternalRegistration/register" method="post" 
 onsubmit="document.getElementById('timezone').value = Intl.DateTimeFormat().resolvedOptions().timeZone; return true;" novalidate="novalidate">
    <label>Ваше имя:</label> <input name="name"/>
    <label>Ваш e-mail:</label> <input name="email"/>
    <label>Ваш телефон:</label> <input name="phone"/>
    <input type="hidden" name="promouser" value="ExternalRegistration"/>
    <input type="hidden" name="publicid"/> <!-- Можно использовать для указания ИНН -->
    <input type="hidden" name="scid"/> <!-- Можно использовать для указания идентификатора обслуживающей организации -->
    <input type="hidden" name="timezone" id="timezone"/>
    <input type="hidden" name="unknownErrorRedirectUrl" value="#msgUnknownError"/>
    <input type="hidden" name="userExistsErrorRedirectUrl" value="#msgEmailExists"/>
    <input type="submit" value="Начать работу"/>
</form>

Результат

1. При успешном выполнении метода register  HTTP-сервиса внешней регистрации ExternalRegistration в сервисе Фреш создается новый абонент и новый пользователь, имеющий права владельца этого абонента.
2. Если при регистрации используется режим Пропустить подтверждение регистрационных данных, то  выполняется редирект 302 на метод завершения регистрации {baseURL}/a/extreg/hs/FastExternalRegistration/CompleteRegistration/{id}, где id – идентификатор приглашения. При этом:
   • если для абонента создается приложение (включен режим Создать приложение), то пользователю выводится страница подготовки приложения, которая показывает надпись о подготовке приложения, периодически проверяет готовность приложения, и при готовности выполняет переход на страницу приложения.
   • если для абонента не создается приложения (режим Создать приложение выключен), то пользователю выводится страница подготовки личного кабинета пользователя, которая показывает надпись о подготовке личного кабинета, периодически проверяет его готовность, и при готовности выполняет переход в личный кабинет пользователя. Адрес личного кабинета берется из параметра ВнешнийАдресЭтогоПриложения витрины, с которой инициирована регистрация (если в сервисе не используются витрины - то из одноименного параметра настроек конфигурации менеджера сервиса).
3. Если при регистрации не используется режим Пропустить подтверждение регистрационных данных, то выполняется редирект 302 на адрес активации через сервис внешней регистрации (при его отсутствии - на адрес активации по приглашению).

Обработка ошибок

Если указаны параметры редиректов, то производится редирект с кодом 302 на указанный адрес. Если адрес этого редиректа не указан, возвращается исключение с кодом 500 и текстом ошибки. Возможные адреса редиректов:

Если при подготовке приложения произошла ошибка, выполняется повтор попытки. Если приложение не удалось создать после 3 попыток, то в браузер пользователя выводится сообщение об ошибке подготовки приложения с указанием причины, если она известна.

Если оказалось, что подготовленное приложение требует наличия подписки на тариф сервиса, отсутствующей у абонента, то в браузер пользователя выводится сообщение о том, что приложение недоступно без оформления подписок на тарифы.

Для сопоставления (привязки) пользователя стороннего провайдера аутентификации и учетной записи существующего пользователя сервиса применяется метод  bind  HTTP-сервиса внешней регистрации ExternalRegistration.

Для вызова этого метода выполняется POST-запрос следующего вида:

Запрос

POST {baseURL}/a/extreg/hs/ExternalRegistration/bind/
Content-Type: application/x-www-form-urlencoded
Accept: text/html

Здесь предполагается, что HTTP-сервис внешней регистрации ExternalRegistration опубликован с относительным адресом  /a/extreg

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

Если параметры   return_to и/или  cmd не заданы в параметрах запроса, используются значения из соответствующих полей JWT-токена SSO OpenID-провайдера аутентификации сервиса. 

Параметр return_to должен содержать адрес, с разрешенным для перехода именем сайта. Разрешенные имена сайта задаются администратором сервиса.

Обработка ошибок

В следующих случаях возвращается ответ с HTTP-кодом состояния 400 и текстом ошибки:

• не указан параметр sso
• если для стороннего провайдера аутентификации не разрешена привязка
• если в поле scope  JWT-токена SSO провайдера аутентификации не найдена строка bind
• не указано корректное значение адреса возврата ( return_to ).

Вывод окна привязки

Если при вызове не был указан параметр  login , выводится окно привязки (по шаблону текстов Страница привязки).

Результат выполнения

После успешного выполнения привязки существующий пользователь сервиса сможет входить в приложения сервиса, используя аутентификацию стороннего провайдера аутентификации. Сразу после привязки пользователь переходит по адресу возврата, указанному в параметре привязки  return_to JWT-токена SSO, или параметра запроса, если он указан. 

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

Запрос

GET {baseURL}/a/fastreg/hs/FastExternalRegistration/ComleteRegistration/{registration_code}
Content-Type: application/x-www-form-urlencoded
Accept: text/html

Здесь предполагается, что HTTP-сервис FastExternalRegistration опубликован с относительным адресом  /a/fastreg

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

В процессе ожидания производится редирект на страницу подготовки приложения или личного кабинета, если приложение не создается. 

После завершения подготовки приложения или личного кабинета производится редирект в приложение или личный кабинет и осуществляется вход пользователя без ввода данных регистрации. Также на почту пользователя отправляется письмо с данными регистрации.

В случае ошибок возвращается ответ с HTTP-кодом состояния  500 и описанием возникших ошибок.