Puedes usar la API de inicio de sesión único (SSO) para iniciar sesión automáticamente a tus visitantes en tu sala de chat. Esto puede resultar útil si tienes un área de inicio de sesión independiente en tu sitio web y no quieres que tus visitantes inicien sesión dos veces.

La API de SSO te permite enviar una solicitud HTTP desde tu aplicación para iniciar o cerrar sesión de un usuario en tu sala de chat. La API devuelve un token, que luego se usa en una pequeña etiqueta IMG en la página siguiente para almacenar las cookies del navegador necesarias.

Si utilizas PHP, te recomendamos encarecidamente que utilices nuestro Biblioteca SSO. Contiene un archivo con todo el código de la biblioteca que necesitará y otros archivos con ejemplos de uso.

Si está utilizando WordPress para su sitio web, tenemos un Plugin de WordPress que integra automáticamente su proceso de inicio de sesión y registro.

Siga las instrucciones que aparecen a continuación para integrar la API de SSO en su sitio web.

• Obtenga su clave de API
• Realice la solicitud para generar un token de acceso
• Analice la respuesta para recuperar el token de acceso
• Solicitud de inicio de sesión en la sala de chat
• Cerrar sesión en la sala de chat
• Configuración de URL
• Registrar un usuario en la sala de chat
• Eliminar un usuario
• Editar detalles de usuario
• Notas importantes

Obtenga su clave de API

La clave de API se pasa como parámetro en las llamadas a la API para verificar que eres un usuario autorizado de la API de la sala de chat. Su clave de API es como la contraseña de su cuenta y debe mantenerse privada y segura.

Puede obtener la clave de API de la sala de chat de Website Toolbox siguiendo las instrucciones que se indican a continuación:

1. Inicie sesión en su cuenta de Website Toolbox.
2. Haz clic en el enlace Configuración.
3. Copie la clave de API mencionada junto a la opción de clave de API.

Realice la solicitud para generar un token de acceso

En el script de inicio de sesión de tu sitio web, realiza una solicitud HTTP a la URL de inicio de sesión de la API de SSO:

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

Sustituya APIKEY por la clave de API secreta.

Sustituya USERNAME por el nombre de usuario del usuario que va a iniciar sesión.

Sustituya EMAIL por la ID de correo electrónico del usuario que va a iniciar sesión.

Sustituya AVATARURL por la URL de la imagen de perfil del usuario. Esto es opcional. De lo contrario, el usuario siempre puede configurar su avatar en la propia sala de chat.

Sustituya PASSWORD por la contraseña no cifrada del usuario que va a iniciar sesión.

El nombre de usuario y la contraseña son parámetros opcionales que solo se usarán si es necesario crear la cuenta porque aún no existe. Si la cuenta se crea sin contraseña, el usuario no podrá iniciar sesión directamente en la sala de chat a menos que restablezca primero su contraseña en la página de inicio de sesión. El inicio de sesión único funcionaría sin problemas incluso sin que la cuenta del usuario tuviera una contraseña.

Analice la respuesta para recuperar el token de acceso

Analice la respuesta JSON de la solicitud enviada a generar token de acceso para recuperar el token de autenticación, es decir, «access_token». La respuesta de JSON tendrá un aspecto similar al siguiente:

{
 «éxito»: cierto,
 «message»: «Este es un mensaje de éxito o fracaso. «,
 «access_token»: «88sngrlFrql»
}

éxito: corresponde al estado de la solicitud. Es cierto si el token de autenticación se genera correctamente. De lo contrario, es falso.

mensaje: es el mensaje que se comparte en la respuesta. Es más útil para la respuesta a errores.

access_token: es el token de acceso generado para el usuario después de una autenticación exitosa. Este token caducará en 60 minutos para garantizar la seguridad.

Solicitud de inicio de sesión en la sala de chat

En su sitio web, añada la siguiente etiqueta HTML IMG a la página de inicio de «inicio de sesión exitoso»:

Sustituya ACCESS_TOKEN por el access_token, recuperado paso a paso Analice la respuesta para recuperar el token de acceso>..

Sustituya REMEMBERME por el valor 0 o 1. Para que el navegador recuerde la información de inicio de sesión del usuario incluso después de cerrar el navegador, sustituya REMEMBERME por 1; de lo contrario, sustitúyala por 0 para borrar la información de inicio de sesión una vez que se cierre el navegador.

La ventana del navegador que carga la etiqueta IMG iniciará sesión en la sala de chat como el usuario con el nombre de usuario proporcionado al realizar la solicitud a generar token de acceso.

El navegador Safari incluye una política de cookies conservadora que limita la escritura de cookies solo a las páginas elegidas («a las que ha navegado») el usuario. Esto evita que la cookie de inicio de sesión del foro se establezca en la página de inicio de «inicio de sesión exitoso». Por lo tanto, la única forma de hacer que el inicio de sesión único funcione en el navegador Safari es introducir también el token de autenticación en el enlace de la sala de chat de tu sitio web. Por ejemplo:

Cerrar sesión en la sala de chat

En caso de que el usuario quiera cerrar sesión en la sala de chat o cuando cierre sesión en el sitio web, añada la siguiente etiqueta HTML IMG a su página de inicio de «cierre de sesión exitoso»:

Sustituya ACCESS_TOKEN por el access_token, recuperado paso a paso Analice la respuesta para recuperar el token de acceso.

Si no tiene el token de autenticación que se devolvió durante el inicio de sesión, puede recuperarlo o regenerarlo (si ha caducado) realizando la solicitud a generar token de acceso API.

Configuración de URL

Puedes configurar las URL de tu sitio web siguiendo las instrucciones que aparecen a continuación:

1. Inicie sesión en su cuenta de Website Toolbox.
2. Haz clic en el enlace Configuración.
3. En la sección «Inicio de sesión único», especifica las URL de tu sitio web para las siguientes páginas:
• Página de inicio de sesión: especifique la dirección de la página de inicio de sesión de su sitio web para asegurarse de que todos los inicios de sesión en las salas de chat se realicen mediante el formulario de inicio de sesión de su sitio web.
• Página de cierre de sesión: especifique la dirección de la página de cierre de sesión de su sitio web para asegurarse de que a los usuarios se les muestre la página de cierre de sesión de su sitio web una vez que hayan cerrado sesión en la sala de chat.
• Página de registro: especifique la dirección de la página de registro de su sitio web para asegurarse de que los usuarios vean la página de registro de su sitio web al hacer clic en el enlace «Crear cuenta» en la página de inicio de sesión de la sala de chat.

Registrar un usuario en la sala de chat

Para registrar a un usuario en la sala de chat, envía una solicitud HTTP a la URL de registro de usuario de la API de SSO:

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

Sustituya APIKEY por la clave de API secreta.

Sustituya USERNAME por el nombre de usuario del usuario que se va a registrar.

Sustituya EMAIL por la ID de correo electrónico del usuario que se va a registrar.

Sustituya PASSWORD por la contraseña no cifrada del usuario que se va a registrar. Se trata de un parámetro opcional. En los casos en que se cree una cuenta sin contraseña, el usuario no podrá iniciar sesión directamente en la sala de chat a menos que restablezca primero su contraseña en la página de inicio de sesión. El inicio de sesión único funcionaría sin problemas incluso sin que la cuenta del usuario tuviera una contraseña.

¿Sustituir AVATARURL por ser usuario registrado? perfil s URL de la imagen. Esto es opcional.

El envío de una solicitud de registro es opcional, ya que las cuentas se crearán automáticamente si aún no existen durante un solicitud de inicio de sesión único.

La respuesta de JSON también devolverá un token de acceso que se puede usar para iniciar sesión al usuario. Siga los pasos que se indican en Analice la respuesta para recuperar el acceso Símbolo y Solicitud de inicio de sesión en el chat Habitación para iniciar sesión con el usuario recién registrado.

Eliminar un usuario

Para eliminar usuarios de la sala de chat, envía una solicitud HTTP a la URL de eliminación de usuarios de la API de SSO:

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

Sustituya APIKEY por la clave de API secreta.

Sustituya los CORREOS ELECTRÓNICOS por las direcciones de correo electrónico de los usuarios que se van a eliminar. Puede contener una sola dirección de correo electrónico o varias direcciones de correo electrónico separadas por comas.

Editar detalles de usuario

Para editar los detalles del usuario de la sala de chat, envía una solicitud HTTP a la URL de edición del usuario de la API de SSO:

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

Sustituya APIKEY por la clave de API secreta.

Sustituya USER por la dirección de correo electrónico actual del usuario.

Sustituya NEWUSERNAME por el nuevo nombre de usuario que debe configurarse.

Sustituya NEWEMAIL por el nuevo correo electrónico que debe configurarse.

Sustituya NEWPASSWORD por la nueva contraseña que debe configurarse.

Sustituya NEWAVATARURL por la nueva URL de avatar que debe configurarse.

Los parámetros apikey y user son campos obligatorios. Los demás campos son opcionales. No debe agregar parámetros en la URL cuyo valor no deba actualizarse para el usuario. El valor de «nombre de usuario» y «correo electrónico» no se actualizará si está en blanco.

Notas importantes

• ¿Necesitas ayuda? Nuestros desarrolladores pueden configurar la integración del inicio de sesión único en su sitio web.Póngase en contacto con nosotros
• Para acceder a la sala de chat, debe haber un enlace a la sala de chat en su página, como:

  Lanzar sala de chat

• El CLIENTE debe reemplazarse por el nombre de usuario de la sala de chat de Website Toolbox.
• Las respuestas se pueden analizar con fines de depuración. La respuesta de JSON tendrá un aspecto similar a esto.
• La cadena de consulta debe estar codificada en URL.