Você pode usar a API Single Sign On (SSO) 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 que seus visitantes façam login duas vezes.
A API SSO permite que você envie uma solicitação HTTP de dentro do seu aplicativo para que um usuário entre ou saia da sua sala de bate-papo. Um token é retornado pela API, que é então usado em uma pequena tag IMG na próxima página para armazenar os cookies necessários do navegador.
Se você estiver usando PHP, é altamente recomendável usar nosso Biblioteca SSO. Ele contém um arquivo com todo o código da biblioteca que você precisará e outros arquivos com exemplos de uso.
Se você estiver usando o WordPress para o seu site, temos um Plugin WordPress que integra automaticamente seu processo de login e inscrição.
Siga as instruções abaixo para integrar a API SSO em seu site.
- Obtenha sua chave de API
- Faça a solicitação para gerar o token de acesso
- Analise a resposta para recuperar o token de acesso
- Solicitação de login na sala de bate-papo
- Sair da sala de bate-papo
- Configurações de URL
- Registrar um usuário na sala de bate-papo
- Excluir um usuário
- Editar detalhes do usuário
- Notas importantes
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 da sala de bate-papo. Sua chave de API é como uma senha para sua conta e deve ser mantida privada e segura.
Você pode obter a chave da API da sala de bate-papo do Website Toolbox seguindo as instruções abaixo:
- Faça login na sua conta do Website Toolbox.
- Clique no link Configurações.
- Copie a chave de API mencionada ao lado da opção de chave de API.
Faça a solicitação para gerar o token de acesso
No script de login do seu site, faça uma solicitação HTTP para o URL de login 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 pelo URL da foto do perfil do usuário. Isso é opcional. Caso contrário, o usuário sempre poderá definir seu avatar na própria sala de bate-papo.
Substitua PASSWORD pela senha não criptografada do usuário a ser 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 conseguirá fazer login diretamente na sala de bate-papo, a menos que primeiro redefina a senha na página de login. O login com SSO funcionaria sem problemas, mesmo sem a conta do usuário ter uma senha.
Analise a resposta para recuperar o token de acesso
Analise 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 do JSON será semelhante a esta:
{
“sucesso”: verdadeiro,
“message”: “Esta é uma mensagem de sucesso ou falha. “,
“access_token”: “88SngRLfrQL”
}
sucesso - corresponde ao status da solicitação. É verdade, se o token de autenticação for gerado com sucesso. Caso contrário, é falso.
mensagem - É a mensagem compartilhada novamente na resposta. É mais útil para resposta a erros.
access_token - É o token de acesso gerado para o usuário após a autenticação bem-sucedida. Esse token expirará em 60 minutos para garantir a segurança.
Solicitação de login na sala de bate-papo
Em seu site, adicione a seguinte tag HTML IMG à sua página inicial de “login bem-sucedido”:
Substitua ACCESS_TOKEN pelo access_token, recuperado na etapa Analise a resposta para recuperar o token de acesso>..
Substitua REMEMBERME pelo valor 0 ou 1. Para que o navegador se lembre das informações de login do usuário mesmo depois que o navegador for fechado, substitua REMEMBERME por 1, caso contrário, substitua-o por 0 para limpar as informações de login quando o navegador for fechado.
A janela do navegador que carrega a tag 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 vem com uma política conservadora de cookies que limita a gravação de cookies somente às páginas escolhidas (“navegadas”) pelo usuário. Isso evita que o cookie de login do fórum seja definido na página inicial “login bem-sucedido”. Portanto, a única maneira de fazer o Login Único funcionar no navegador Safari é também passar o token de autenticação no link da sua sala de bate-papo em seu site. Por exemplo:
Sair da sala de bate-papo
Caso o usuário queira sair da sala de bate-papo ou sair do site, adicione a seguinte tag HTML IMG à sua página de destino “sair com sucesso”:
Substitua ACCESS_TOKEN pelo access_token, recuperado na etapa Analise 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 poderá 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:
- Faça login na sua conta do Website Toolbox.
- Clique no link Configurações.
- Na seção “Login único”, especifique os URLs do seu site para as seguintes páginas:
- Página de login: especifique o endereço da página de login do seu site para garantir que todos os logins da sala de bate-papo ocorram usando o formulário de login do seu site.
- Página de desconexão: especifique o endereço da página de desconexão do seu site para garantir que os usuários vejam a página de desconexão do seu site depois de saírem da sala de bate-papo.
- Página de inscrição: especifique o endereço da página de inscrição do seu site para garantir que os usuários vejam a página de inscrição do seu site ao clicar no link “Criar conta” na página de login da sala de bate-papo.
Registrar 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 inscrição 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. Esse é um parâmetro opcional. Nos casos em que uma conta é criada sem uma senha, o usuário não conseguiria fazer login diretamente na sala de bate-papo, a menos que primeiro redefinisse sua senha na página de login. O login com SSO funcionaria sem problemas, mesmo sem a conta do usuário ter uma senha.
Substituir AVATARURL por usuário a ser registrado? perfil s URL da imagem. Isso é opcional.
O envio de uma solicitação de inscrição é opcional, pois as contas serão criadas automaticamente se ainda não existirem durante um solicitação de login único.
A resposta JSON também retornará um token de acesso que pode ser usado para fazer login do usuário. Siga as etapas em Analise a resposta para recuperar o acesso Ficha e Solicitação de login para o chat Sala para fazer login com o 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 do usuário da API SSO:
http://CLIENT.discussionchatroom.com/sso/user/delete?apikey=APIKEY&emails=EMAILS
Substitua APIKEY pela chave secreta da API.
Substitua E-MAILS 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írgula.
Editar detalhes do usuário
Para editar detalhes do usuário da sala de bate-papo, faça uma solicitação HTTP para a URL do usuário de edição da API SSO:
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 deva ser atualizado para o usuário. O valor de “nome de usuário” e “e-mail” 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.Entre em contato conosco
- Para acessar a sala de bate-papo, deve haver um link de sala de bate-papo em sua página, como:
- O CLIENTE deve ser substituído pelo nome de usuário da sala de bate-papo do Website Toolbox.
- As respostas podem ser analisadas para fins de depuração. A resposta do JSON será semelhante a isso.
- A string de consulta deve ser codificada em URL.