Help > Chat Room > 将军 > 单一登录集成

单一登录集成

您可以使用单一登录(SSO) API将访客自动登录到聊天室。 如果您在网站上有一个单独的登录区域,并且您不想让您的访问者登录两次,这将很有帮助。

SSO API允许您从应用程序内发送HTTP请求,以便将用户登录到或退出聊天室。 API会返回一个令牌,然后在下一页的小IMG标签中使用它来存储必要的浏览器Cookie。

如果您使用的是PHP,我们强烈建议您使用我们的 SSO圖書館。 它包含一个包含您所需的所有库代码的文件以及具有示例使用情况的其他文件。

如果你使用WordPress为您的网站,我们有一的 WordPress的插件 自动集成您的登录和注册过程。

请按照以下说明将SSO API集成到您的网站中。

获取您的API密钥

API密钥作为API调用中的参数传递,以验证您是聊天室API的授权用户。 您的API密钥与您的账户密码类似,应保持私有和安全。

您可以按照以下说明获取您的Website Toolbox聊天室API密钥:

  1. 登录到您的Website Toolbox帐户。
  2. 单击设置链接。
  3. 复制API密钥选项旁边提到的API密钥。

请求生成访问令牌

在网站登录脚本中,在URL中向SSO API登录发出HTTP请求:

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

将APIKEY替换为秘密API密钥。

将USERNAME替换为要登录用户的用户名。

将EMAIL替换为要登录用户的电子邮件ID。

将AVATARURL替换为用户个人资料图片的网址。 这是可选的。 否则,用户可以始终在聊天室自己设置自己的头像。

将PASSWORD替换为要登录用户的未加密密码。

用户名和密码是可选参数,仅当账户尚未存在而需要创建时才使用。 如果创建帐户时没有密码,则用户将无法直接登录到聊天室,除非他们在登录页面上首次重置密码。 即使没有用户的帐户有密码,SSO登录也会顺利工作。

解析响应以检索访问令牌

解析发送到的请求的JSON响应 生成访问令牌 检索身份验证令牌,即 “访问_令牌”. JSON响应将类似于以下内容:

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

成功-它对应于请求的状态。 如果成功生成身份验证令牌,则为true。 否则,这是虚假的.

消息-这是在响应中共享的消息。 它更适用于错误响应。

access_token -这是成功身份验证后为用户生成的访问令牌。 此令牌将在60分钟内过期,以确保安全。

登录请求到聊天室

在您的网站上,将以下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替换为按步骤检索的访问_令牌 解析检索访问令牌的响应>..

将“记号”替换为值0或1。 要让浏览器记住用户的登录信息,即使在浏览器关闭后,请将REMEMBERME替换为1,否则将其替换为0,一旦浏览器关闭,清除登录信息。

加载IMG标签的浏览器窗口将作为用户登录到聊天室提供用户名,同时提出请求 生成访问令牌

Safari浏览器使用保守的Cookie策略发货,该策略将Cookie写入限制为用户选择的页面(“导航到”)。 这会阻止在“成功登录”登录页面上设置论坛登录Cookie。 因此,使“单点登录”在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替换为按步骤检索的访问_令牌 解析响应以检索访问令牌

如果您没有在登录期间返回的身份验证令牌,则可以通过向 生成访问令牌 API.

网址设置

您可以按照以下说明设置网站URL:

  1. 登录到您的Website Toolbox帐户。
  2. 单击设置链接。
  3. 在“单一登录部分”下,为以下页面指定您的网站URL:
    • 登录页面:指定您网站登录页面的地址,以确保所有聊天室登录都使用您的网站登录表单。
    • 登出页面:指定您网站登出页面的地址,以确保用户在登出聊天室后显示您的网站登出页面。
    • 注册页面:指定您网站注册页面的地址,以确保用户在点击聊天室登录页面上的“创建账户”链接时显示您网站的注册页面。

在聊天室注册用户

要在聊天室注册用户,请向SSO API用户注册URL发出HTTP请求:

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

将APIKEY替换为秘密API密钥。

将USERNAME替换为要注册用户的用户名。

将EMAIL替换为要注册用户的电子邮件ID。

将PASSWORD替换为要注册用户的未加密密码。 这是一个可选参数。 在没有密码的情况下创建帐户时,用户将无法直接登录到聊天室,除非他们首先在登录页面上重置密码。 即使没有用户的帐户有密码,SSO登录也会顺利工作。

将AVATARURL替换为注册用户? 个人资料图片URL。 这是可选的。

发送注册请求是可选的,因为如果账户在 登录请求单点登录

JSON响应还将返回可用于登录用户的访问令牌。 按照以下步骤操作: 解析响应以检索访问令牌登录请求到聊天室 以登录新注册的用户。

删除用户

要从聊天室删除用户,请向SSO API用户发出HTTP请求删除URL:

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

将APIKEY替换为秘密API密钥。

将EMAILS替换为要删除用户的电子邮件地址。 它可以保留单个电子邮件地址或多个逗号分隔的电子邮件地址。

编辑用户详细信息

要编辑聊天室用户的详细信息,请向SSO API编辑用户URL发出HTTP请求:

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。

用需要设置的新头像URL替换NEWAVATARURL。

参数apikey和用户是必填字段。 其他字段是可选的。 您不应在URL中添加其值不应为用户更新的参数。 “用户名”和“电子邮件”的值如果为空,将不会更新。

重要说明

  • 需要帮助? 我们的开发人员可以在您的网站上设置单一登录集成,只需149美元。聯絡我們
  • 要访问聊天室,您的页面上应该有聊天室链接,如:

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

  • CLIENT应该由您的Website Toolbox聊天室用户名替换。
  • 响应可以进行解析以进行调试。 JSON响应将类似于 这个
  • 查询字符串必须是URL编码。


If you still need help, please contact us.