Help > Chat Room > Генеральной > Интеграция единого входа

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

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

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

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

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

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

Получить ключ API

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

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

  1. Войдите в свою учетную запись панели инструментов веб-сайта.
  2. Щелкните ссылку Настройки.
  3. Скопируйте ключ API, указанный рядом с параметром API Key.

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

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

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

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

Замените ИМЯ USERNAME на имя пользователя для входа в систему.

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

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

Замените ПАРОЛЬ незашифрованным паролем пользователя, который должен войти в систему.

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

Разбор ответа для получения маркера доступа

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

{
  "success" : true,
  "message" : "This is success or failure message.",
  "access_token" : "88SngRlfrqL"
}

Успешное - соответствует тому, как выполняется запрос. Это верно, если маркер аутентификации сгенерирован успешно. Иначе это ложно.

message - это сообщение, совместно используемое в ответе. Он более подходит для ответа на сообщение об ошибке.

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

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

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

<img border="0" width="1" height="1" alt="" src= "//CLIENT.discussionchatroom.com/sso/token/login?access_token=ACCESS_TOKEN&rememberMe=REMEMBERME" >

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

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

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

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

<a href="http://CLIENT.discussionchatroom.com/?access_token=ACCESS_TOKEN&rememberMe=REMEMBERME">Chat Room</a>

Выход из комнаты чата

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

<img border="0" width="1" height="1" alt="" src="//CLIENT.discussionchatroom.com/sso/token/logout?access_token=ACCESS_TOKEN" >

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

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

Параметры URL

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

  1. Войдите в свою учетную запись панели инструментов веб-сайта.
  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 на имя пользователя для регистрации.

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

Замените ПАРОЛЬ незашифрованным паролем регистрируемого пользователя. Непредваряемый параметр. В тех случаях, когда учетная запись создается без пароля, пользователь не сможет войти непосредственно в чат-комнату, пока он не сбросит пароль на странице входа. Вход в систему SSO будет работать гладко даже без пароля учетной записи пользователя.

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

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

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

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

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

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

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

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

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

Чтобы изменить сведения о пользователе комнаты чата, сделайте 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 являются обязательными. Все другие поля являются необязательными. Не следует указывать в адрес адреса, значение которого не должно обновляться для пользователя. Значение «username» и «email» не будет обновлено, если оно пустое.

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

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

    <a href=”http://CLIENT.discussionchatroom.com/”>Launch chat room</a>

  • КЛИЕНТ должен быть заменен вашим именем в чате Toolbox Веб-сайта.
  • Ответы могут быть разобраны для отладки. Ответ в ответ на запрос будет таким же, как этой.
  • Строка запроса должна быть закодирована URL-адресом.


If you still need help, please contact us.