Features Pricing No credit card required
Help

Help > Chat Room > Интеграция веб-сайтов > Интеграция системы единого входа

Интеграция системы единого входа

Вы можете использовать API единого входа (SSO) для автоматического входа посетителей в чат. Это может быть полезно, если у вас есть отдельная зона для входа на сайт и вы не хотите, чтобы посетители заходили в систему дважды.

SSO API позволяет отправлять HTTP-запрос из приложения для входа пользователя в чат-комнату или выхода из нее. API возвращает токен, который затем используется в небольшом теге IMG на следующей странице для хранения необходимых файлов cookie браузера.

Если вы используете PHP, мы настоятельно рекомендуем использовать наш Библиотека SSO. Он содержит один файл со всем необходимым библиотечным кодом и другие файлы с примерами использования.

Если вы используете WordPress для своего веб-сайта, у нас есть Плагин для WordPress который автоматически объединяет процесс входа в систему и регистрации.

Следуйте приведенным ниже инструкциям, чтобы интегрировать SSO API на свой веб-сайт.

Получите свой ключ API

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

Вы можете получить ключ API для чата Website Toolbox, следуя приведенным ниже инструкциям:

  1. Войдите в свою учетную запись Website Toolbox.
  2. Нажмите на ссылку Настройки.
  3. Скопируйте ключ API, указанный рядом с опцией «Ключ API».

Сделайте запрос на создание токена доступа

В скрипте входа на ваш веб-сайт сделайте HTTP-запрос к URL-адресу входа SSO API:

http://CLIENT.discussionchatroom.com/sso/token/generate?apikey=APIKEY&username=USERNAME&email=EMAIL&avatarUrl=AVATARURL&password=PASSWORD

Замените APIKEY секретным ключом API.

Замените USERNAME на имя пользователя, который необходимо войти в систему.

Замените EMAIL идентификатором электронной почты пользователя, который нужно войти в систему.

Замените AVATARURL URL-адресом изображения профиля пользователя. Это необязательно. В противном случае пользователь всегда может установить свой аватар в самом чате.

Замените PASSWORD незашифрованным паролем пользователя, который необходимо войти в систему.

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

Проанализируйте ответ, чтобы получить токен доступа

Проанализируйте ответ JSON на запрос, отправленный на сгенерировать токен доступа для получения токена аутентификации, например «access_token». Ответ JSON будет выглядеть следующим образом:

{
 «успех»: правда,
 «сообщение»: «Это сообщение об успехе или неудаче. «,
 «токен доступа»: «88sngrlFRQL»
}

успех — соответствует статусу запроса. Это верно, если токен аутентификации создан успешно. В противном случае это неверно.

сообщение — это сообщение, переданное в ответ. Это более полезно для реагирования на ошибки.

access_token - это токен доступа, созданный для пользователя после успешной аутентификации. Срок действия этого токена истечет через 60 минут для обеспечения безопасности.

Запрос на вход в чат

На своем веб-сайте добавьте следующий HTML-тег IMG на целевую страницу «Вход в систему выполнен успешно»:

» src= «//CLIENT.discussionchatroom.com/sso/token/ login?access_token=ACCESS_TOKEN&rememberMe=REMEMBERME

Замените ACCESS_TOKEN токеном access_token, полученным на шаге Проанализируйте ответ, чтобы получить токен доступа>..

Замените REMEMBERME значением 0 или 1. Чтобы браузер запомнил данные для входа пользователя даже после закрытия браузера, замените REMEMBERME на 1, в противном случае замените его на 0, чтобы удалить данные входа после закрытия браузера.

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

Браузер Safari придерживается консервативной политики использования файлов cookie, которая ограничивает запись файлов cookie только на выбранных («перешедших») пользователем страницах. Это предотвращает установку файла cookie для входа в форум на целевой странице «Вход в систему выполнен успешно». Поэтому единственный способ заставить систему единого входа работать в браузере Safari — это также ввести токен аутентификации по ссылке в чате на вашем веб-сайте. Например:

Комната чата

Выйдите из чата

Если пользователь хочет выйти из чата или выйти из веб-сайта, добавьте следующий тег HTML IMG на целевую страницу «Выйти из системы успешно»:

Замените ACCESS_TOKEN токеном access_token, полученным на шаге Проанализируйте ответ, чтобы получить токен доступа.

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

Настройки URL-адреса

Вы можете установить URL-адреса своего веб-сайта, следуя приведенным ниже инструкциям:

  1. Войдите в свою учетную запись Website Toolbox.
  2. Нажмите на ссылку Настройки.
  3. В разделе «Единый вход» укажите URL-адреса веб-сайтов для следующих страниц:
    • Страница входа: укажите адрес страницы входа на ваш веб-сайт, чтобы все входы в чаты осуществлялись с использованием формы входа на ваш веб-сайт.
    • Страница выхода: укажите адрес страницы выхода на вашем сайте, чтобы после выхода из чата пользователям отображалась страница выхода из чата.
    • Страница регистрации: укажите адрес страницы регистрации на вашем сайте, чтобы при нажатии на ссылку «Создать учетную запись» на странице входа в чат пользователям отображалась страница регистрации на вашем сайте.

Зарегистрируйте пользователя в чате

Чтобы зарегистрировать пользователя в чате, отправьте HTTP-запрос на URL-адрес регистрации пользователя SSO API:

http://CLIENT.discussionchatroom.com/sso/user/register?apikey=APIKEY&username=USERNAME&email=EMAIL&password=PASSWORD&avatarUrl=AVATARURL

Замените APIKEY секретным ключом API.

Замените USERNAME на имя пользователя, который нужно зарегистрировать.

Замените EMAIL идентификатором электронной почты регистрируемого пользователя.

Замените PASSWORD незашифрованным паролем регистрируемого пользователя. Это необязательный параметр. В тех случаях, когда учетная запись создана без пароля, пользователь не сможет войти непосредственно в чат, пока сначала не изменит свой пароль на странице входа в систему. Вход в систему SSO будет работать без проблем даже без пароля для учетной записи пользователя.

Заменить AVATARURL на «Зарегистрироваться»? Профиль пользователя URL-адрес изображения. Это необязательно.

Отправка запроса на регистрацию необязательна, так как учетные записи будут созданы автоматически, если их еще не было в течение запрос на вход в систему с одним входом.

Ответ JSON также вернет токен доступа, который можно использовать для входа пользователя в систему. Следуйте инструкциям, приведенным в Проанализируйте ответ, чтобы получить доступ Токен а также Запрос на вход в чат Комната для входа в систему вновь зарегистрированного пользователя.

Удалить пользователя

Чтобы удалить пользователей из чата, отправьте HTTP-запрос на URL-адрес удаления пользователей SSO API:

http://CLIENT.discussionchatroom.com/sso/user/delete?apikey=APIKEY&emails=EMAILS

Замените APIKEY секретным ключом API.

Замените EMAILS адресами электронной почты удаляемых пользователей. Он может содержать один адрес электронной почты или несколько адресов электронной почты, разделенных запятыми.

Изменить сведения о пользователе

Чтобы изменить сведения о пользователе чата, отправьте HTTP-запрос на URL-адрес пользователя для редактирования API SSO:

http://CLIENT.discussionchatroom.com/sso/user/edit?apikey=APIKEY&user=USER&username=NEWUSERNAME&email=NEWEMAIL&password=NEWPASSWORD&avatarUrl=NEWAVATARURL

Замените APIKEY секретным ключом API.

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

Замените NEWUSERNAME новым именем пользователя, которое необходимо установить.

Замените NEWEMAIL новым электронным письмом, который необходимо настроить.

Замените NEWPASSWORD новым паролем, который необходимо установить.

Замените NEWAVATARURL новым URL-адресом аватара, который необходимо задать.

Параметры apikey и user являются обязательными полями. Остальные поля являются необязательными. Не следует добавлять в URL-адрес параметры, значение которых не следует обновлять для пользователя. Значения «имя пользователя» и «адрес электронной почты» не будут обновлены, если они пусты.

Важные примечания

  • Нужна помощь? Наши разработчики могут настроить интеграцию Single Sign On на вашем сайте.Свяжитесь с нами
  • Чтобы получить доступ к чату, на вашей странице должна быть ссылка на чат, например:

    Запустить чат-комнату

  • CLIENT следует заменить вашим именем пользователя в чате Website Toolbox.
  • Ответы можно анализировать для отладки. Ответ JSON будет выглядеть примерно так: этот.
  • Строка запроса должна быть закодирована в URL-адресе.


If you still need help, please contact us.


Contact Help Privacy Terms