Help > Chat Room > - General > Integração de Signon Único

Integração de Signon Único

Você pode usar a API SSO (Single Sign On) para registrar automaticamente seus visitantes em sua sala de bate-papo. Isso pode ser útil se você tiver uma área de login separada em seu site e não quiser fazer com que seus visitantes façam login duas vezes.

A API SSO permite que você envie uma solicitação HTTP de dentro de seu aplicativo para fazer login ou saída de um usuário em sua sala de bate-papo. Um token é retornado pela API, que é então usado em uma pequena marca IMG na próxima página para armazenar os cookies necessários do navegador.

Se você estiver usando o PHP, recomendamos usar nosso Biblioteca SSO. Ele contém um arquivo com todo o código da biblioteca que você precisará e outros arquivos com uso de exemplo.

Se você estiver usando o WordPress para o seu site, temos um Plugin WordPress que integra automaticamente seu processo de login e registro.

Siga as instruções abaixo para integrar a API SSO ao seu site.

Obtenha sua chave de API

A Chave de API é passada como um parâmetro em suas chamadas de API para verificar se você é um usuário autorizado da API de sala de bate-papo. A sua chave API é como uma palavra-passe para a sua conta e deve ser mantida privada e segura.

Você pode obter sua chave API do site Toolbox chat room seguindo as instruções abaixo:

  1. Faça login na sua conta da Website Toolbox.
  2. Clique no link Configurações.
  3. Copie a Chave da API mencionada ao lado da opção Chave da API.

Faça a solicitação para gerar o token de acesso

No script de log-in do seu site, faça uma Solicitação HTTP para o URL de log-in da API SSO:

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

Substitua APIKEY pela chave secreta da API.

Substitua USERNAME pelo nome de usuário do usuário a ser conectado.

Substitua EMAIL pelo ID de e-mail do usuário a ser conectado.

Substitua AVATARURL pela URL da imagem de perfil do usuário. Isso é opcional. Caso contrário, o usuário pode sempre definir seu avatar na própria sala de bate-papo.

Substitua PASSWORD pela senha não-descriptografada do usuário conectado.

O nome de usuário e a senha são parâmetros opcionais que só serão usados se a conta precisar ser criada porque ela ainda não existe. Se a conta for criada sem uma senha, o usuário não poderá fazer login diretamente na sala de bate-papo, a menos que primeiro redefina sua senha na página de login. O login SSO funcionaria sem problemas mesmo sem que a conta do usuário tivesse uma senha.

Analisar a resposta para recuperar o token de acesso

Analisar a resposta JSON da solicitação enviada para gerar token de acesso para recuperar o token de autenticação, ou seja, “access_token”. A resposta JSON será semelhante a esta:

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

sucesso - Corresponde ao status da solicitação. É verdade, se o token de autenticação for gerado com êxito. Caso contrário, é falso.

mensagem - É uma mensagem compartilhada de volta na resposta. É mais útil para a resposta a erros.

access_token - É o token de acesso gerado para o usuário após a autenticação bem-sucedida. Esse token será expirado em 60 minutos para garantir a segurança.

Solicitação de login na sala de bate-papo

No seu site, adicione a seguinte tag IMG HTML à sua página de aterrissagem “login bem-sucedido”:

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

Substitua ACCESS_TOKEN pelo access_token, recuperado na etapa Analisar a resposta para recuperar o token de acesso>..

Substitua REMEMBERME pelo valor 0 ou 1. Para que o navegador lembre-se das informações de login do usuário mesmo depois que o navegador for fechado, substitua REMBERME por 1, caso contrário, substitua-o por 0 para limpar as informações de login assim que o navegador for fechado.

A janela do navegador que carrega a marca IMG será registrada na sala de bate-papo como o usuário com o nome de usuário fornecido ao fazer a solicitação para gerar token de acesso.

O navegador Safari é fornecido com uma política de cookies conservadora que limita as gravações de cookies apenas às páginas escolhidas (“navegadas para”) pelo usuário. Isto impede que o cookie de início de sessão do fórum seja definido na página de destino “iniciar sessão com êxito”. Portanto, a única maneira de fazer o logon único funcionar no navegador Safari é também passar o token de autenticação no link da sua sala de bate-papo no seu site. Por exemplo:

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

Sair da sala de bate-papo

Caso o usuário queira fazer logout da sala de bate-papo ou quando o usuário fizer logout do site, adicione a seguinte tag IMG HTML à sua página de aterrissagem “logout successful”:

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

Substitua ACCESS_TOKEN pelo access_token, recuperado na etapa Analisar a resposta para recuperar o token de acesso.

Se você não tiver o token de autenticação que foi retornado durante o login, ele pode ser recuperado ou regenerado (se expirado) fazendo a solicitação para gerar token de acesso API.

Configurações de URL

Você pode definir os URLs do seu site seguindo as instruções abaixo:

  1. Faça login na sua conta da Website Toolbox.
  2. Clique no link Configurações.
  3. Em “Seção de início de sessão único, especifique os URLs do Web site para as seguintes páginas:
    • Página Entrar: Especifique o endereço da página Login do seu site para garantir que todos os logins de salas de bate-papo ocorram usando o formulário de login do seu site.
    • Página de logout: Especifique o endereço da página de logout do seu site para garantir que os usuários sejam mostrados a página de logout do seu site depois de terem saído da sala de bate-papo.
    • Página de registro: Especifique o endereço da página de registro do seu site para garantir que os usuários sejam mostrados a página de registro do seu site ao clicar no link “Criar conta” na página de login da sala de bate-papo.

Registre um usuário na sala de bate-papo

Para registrar um usuário na sala de bate-papo, faça uma solicitação HTTP para o URL de registro do usuário da API SSO:

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

Substitua APIKEY pela chave secreta da API.

Substitua USERNAME pelo nome de usuário do usuário a ser registrado.

Substitua EMAIL pelo ID de e-mail do usuário a ser registrado.

Substitua PASSWORD pela senha não criptografada do usuário a ser registrado. Este é um parâmetro opcional. Nos casos em que uma conta é criada sem uma senha, o usuário não poderá fazer login diretamente na sala de bate-papo, a menos que primeiro redefina sua senha na página de login. O login SSO funcionaria sem problemas mesmo sem que a conta do usuário tivesse uma senha.

Substituir AVATARURL por usuário registrado? URL da imagem de perfil do s. Isso é opcional.

O envio de um pedido de registo é opcional, uma vez que as contas serão criadas automaticamente se ainda não existirem durante um login único na solicitação de login.

A resposta JSON também retornará um token de acesso que pode ser usado para fazer login no usuário. Siga as etapas em Analisar a resposta para recuperar o token de acesso e Solicitação de login na sala de bate-papo para efetuar login no usuário recém-registrado.

Excluir um usuário

Para excluir usuários da sala de bate-papo, faça uma solicitação HTTP para o URL de exclusão de usuário da API SSO:

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

Substitua APIKEY pela chave secreta da API.

Substitua EMAILS pelos endereços de e-mail dos usuários a serem excluídos. Ele pode conter um único endereço de e-mail ou vários endereços de e-mail separados por vírgulas.

Editar detalhes do usuário

Para editar detalhes do usuário da sala de bate-papo, faça uma Solicitação HTTP para a API SSO editar URL do usuário:

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

Substitua APIKEY pela chave secreta da API.

Substitua USER pelo endereço de e-mail atual do usuário.

Substitua NEWUSERNAME pelo novo nome de usuário que precisa ser definido.

Substitua NEWEMAIL pelo novo e-mail que precisa ser definido.

Substitua NEWPASSWORD pela nova senha que precisa ser definida.

Substitua NEWAVATARURL pelo novo URL do avatar que precisa ser definido.

Os parâmetros apikey e user são campos obrigatórios. Os outros campos são opcionais. Você não deve adicionar parâmetros na URL cujo valor não deve ser atualizado para o usuário. O valor de “username” e “email” não será atualizado se estiver em branco.

Notas Importantes

  • Precisa de ajuda? Nossos desenvolvedores podem configurar a integração do Single Sign On em seu site por apenas US $149.Contacte-nos
  • Para acessar a sala de bate-papo, deve haver um link de sala de bate-papo em sua página como:

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

  • O CLIENTE deve ser substituído pelo nome de usuário da sua sala de bate-papo da Caixa de Ferramentas do Website.
  • As respostas podem ser analisadas para fins de depuração. A resposta JSON será semelhante à Isto.
  • A seqüência de caracteres de consulta deve ser codificada por URL.


If you still need help, please contact us.