Usemos Qypher en su propio sitio web
Dependiendo de su dispositivo, es posible que deba tocar en lugar de hacer clic.
Actualmente se publican programas escritos en PHP
* La versión php requiere Ver.7.4 o superior, se recomienda Ver.8.3 o superior.
Por favor, verifique si lo siguiente es posible antes de implementar Qypher
Debe poder responder mediante acceso https (http:// no está permitido)
La API Qypher cifra las comunicaciones internamente, pero por mayor seguridad solo se ofrece en entornos que admiten comunicación https.
La API de Qypher utiliza la biblioteca de cifrado OpenSSL.
Debe poder insertar etiquetas de script libremente
La API Qypher utiliza JavaScript para la visualización, el análisis de códigos QR y la comunicación con el núcleo de Qypher.
Debe poder comunicarse con dominios externos mediante fetch()
La API Qypher envía los datos que analiza a Qypher en un dominio externo (https://qypher.be-on.biz) y recibe los resultados después de compararlos con los datos de Qypher.
Debe poder usar operaciones DOM con input type="file" y elementos canvas
La API Qypher utiliza operaciones DOM para cargar Tarjeta Qypher, analizar códigos QR y manejar botones.
Debe poder insertar elementos personalizados en HTML
La API Qypher inserta elementos personalizados en el HTML antes y después del inicio de sesión.
Debe poder configurar y ejecutar código del lado del servidor (como PHP)
La API Qypher requiere la instalación de un archivo PHP que incluya la clave secreta. Este archivo se encarga de cifrar y descifrar las comunicaciones con Qypher, de verificar claves de un solo uso y de otras tareas críticas.
Una vez confirmado lo anterior, pasemos a la configuración.
Primero, inicie sesión en Qypher.
* El método de inicio de sesión se describe en “Cómo usar Qypher”.
Haga clic en el Integración de Qypher, Detalles de integración de Información personal.
nombre del sitio web de destino :
Ingrese el nombre oficial del sitio web donde se implementará Qypher.
dirección web de Página principal :
Ingrese la dirección de la página de inicio o índice del sitio web, comenzando con https.
Sandbox :
Mientras se seleccione “Sandbox”, la pantalla de inicio de sesión en producción mostrará “En ajuste” y no será posible iniciar sesión. Una vez completadas las pruebas, seleccione “entorno de producción” y haga clic en “actualizar”.
número de inscritos :
Este es el número de usuarios que iniciaron sesión en su sitio registrado a través de Qypher. El mismo usuario solo se cuenta una vez aunque inicie sesión varias veces.
edad que requiere aprobación parental :
Establezca la edad a la que se requiere el consentimiento de los padres. Si no es necesario, seleccione “sin restricción”.
edad permitida para ver :
Para los sitios web con restricciones de edad, establezca la edad. Si no es necesario, seleccione “sin restricción”.
idioma utilizado :
En el futuro, cuando se cree una lista de sitios web que implementan Qypher, se proporcionarán secciones por idioma disponible. Sin embargo, si la traducción automática del navegador sigue mejorando, esta sección puede volverse innecesaria.
datos deseados :
Seleccione los datos de usuario que desea obtener de Qypher. Los datos que se pueden obtener dependen de su plan. Por favor, verifique “Lista de planes”.
dirección web de Términos de Uso :
Ingrese la URL de Términos de Uso comenzando con https.
dirección web de Política de privacidad :
Ingrese la URL de Política de privacidad comenzando con https.
dirección web de después de iniciar sesión :
Ingrese la dirección de la página que se mostrará después del inicio de sesión para los entornos Sandbox y producción, comenzando con https.
dirección web de Webhook :
Ingrese la URL para recibir la información del webhook para los entornos Sandbox y producción, comenzando con https. Si no lo utiliza, puede dejarlo en blanco. Los webhooks están disponibles en planes Pro o superiores.
carpeta para la clave secreta de API :
Al hacer clic en “Descargar conjunto API (ZIP)”, Qypher genera “Archivo de clave secreta”. Ingrese la carpeta donde se colocará este “Archivo de clave secreta”, comenzando con https.
Tipo de idioma de la clave secreta API :
Actualmente solo se ofrece PHP, pero se planea compatibilidad con otros lenguajes. En ese momento podrá seleccionar aquí el idioma de su preferencia.
Plan de uso :
Por favor seleccione su plan. Para más detalles, lea Lista de planes.
Coloque la página de inicio de sesión, clave secreta de API, Términos de Uso, Política de privacidad, Webhook y la página posterior al inicio de sesión dentro del mismo dominio o dentro del mismo subdominio si utiliza subdominios.
Para usuarios con planes Pro o superiores que implementan varios sitios web, seleccione el sitio que desea editar en el menú desplegable “Descargar conjunto API (ZIP)”.
Una vez completada la configuración, descarguémoslo.
Al hacer clic en “Descargar conjunto API (ZIP)”, se descargará en su carpeta de descargas un archivo comprimido llamado “QypherAPIset_(NombreDelSitio).zip”. Haga doble clic en él o descomprímalo de forma similar para abrirlo.
Estructura de archivos
QypherAPIset_(Nombre del sitio web)/
├─ apiScript.txt ← Copie y pegue este contenido en cualquier lugar de su página de inicio de sesión.
├─ Una clave pública que consiste en 50 o más caracteres alfanuméricos aleatorios(1).php ← Archivo PHP para manejar la clave secreta (A partir de ahora, se denominará "archivo de clave privada".)
├─ getData.php ← Copie y pegue este contenido en la página que se muestra después de iniciar sesión.
├─ README.txt ← Manual de usuario
└─ Sandbox/
├─ Sandbox_apiScript.txt ← ( para Sandbox ) Copie y pegue este contenido en cualquier lugar de su página de inicio de sesión.
├─ Sandbox_Una clave pública que consiste en 50 o más caracteres alfanuméricos aleatorios(2).php ← ( para Sandbox ) Archivo de clave secreta
├─ Sandbox_getData.php ← ( para Sandbox ) Copie y pegue este contenido en la página que se muestra después de iniciar sesión.
├─ nine.jpg ← Usuario de prueba Tarjeta Qypher de 9 años para Sandbox (Puede probar acciones que requieren la aprobación de un tutor.)
├─ eleven.jpg ← Usuario de prueba Tarjeta Qypher de 11 años para Sandbox (Puede usarse para verificar el límite de edad para la aprobación del tutor.)
├─ thirty.jpg ← Usuario de prueba Tarjeta Qypher de 30 años para Sandbox (Puede iniciar sesión normalmente como adulto.)
└─ guardian.jpg ← Usuario de prueba Tarjeta Qypher como padre/madre de niños de 9 y 11 años para Sandbox (Utilice esto para probar el flujo de aprobación del tutor.)
Probémoslo en Sandbox
En Sandbox, puede realizar diversos experimentos y pruebas relacionados con el inicio de sesión en Qypher.
Al iniciar sesión desde Sandbox, todas las acciones permanecen en Sandbox y no se reflejan en entorno de producción.
Los correos electrónicos en Sandbox se envían solo a los usuarios que usan Sandbox.
- Copie todo el contenido de Sandbox_apiScript.txt y péguelo en cualquier lugar de la página de inicio de sesión para Sandbox.
Si se introducen los datos deseados en el atributo value de <input type="hidden" id="QypherAnyKey" value="">, se podrán transferir después del inicio de sesión.
( Si el contenido ingresado incluye etiquetas HTML, código JavaScript, rutas de archivos u otros similares, se invalidará automáticamente. Si se detecta un valor malicioso, es posible que el uso de Qypher sea restringido. )
- Coloque Archivo de clave secreta para Sandbox en la ubicación especificada en carpeta para la clave secreta de API dentro de QypherDetalles de integración.
Por favor, colóquelo en el mismo lugar que para entorno de producción. No modifique este archivo bajo ninguna circunstancia. Si se modifica, puede ser invalidado por el sistema central de Qypher, y la solicitud de inicio de sesión podría ser rechazada.
No cambie el nombre del archivo. Qypher no podrá identificarlo.
Después de cargarlo, asegúrese de que los permisos del archivo estén correctamente configurados.
Recomendado 604 o 644
*Si utiliza un servidor Windows, no se requieren los permisos “604 / 644” anteriores, pero asegúrese de que el archivo sea accesible por el servidor web (como IIS) con los permisos adecuados.
- Copie todo el contenido de Sandbox_getData.txt y úselo como base para la página posterior al inicio de sesión para Sandbox.
Ingrese el contenido posterior al inicio de sesión en if($Qypher["success"]){} , y el contenido de error en else{} si falla.
El valor predeterminado tras un inicio de sesión exitoso contiene “Al recargar esta página, deberá volver a iniciar sesión.”.
Un programa PHP pegado en la página posterior al inicio de sesión invoca Archivo de clave secreta y descifra esos datos.
En ese momento, la marca de tiempo de inicio de sesión cifrada se verifica como una contraseña de un solo uso. Si este sello de tiempo difiere en más de 5 segundos, se rechaza el inicio de sesión.
Esta es una medida importante para evitar que otra persona vuelva a la página de inicio de sesión y la recargue después de que un usuario haya cerrado sesión, permitiendo así un acceso no autorizado.
Cualquier modificación dentro de Archivo de clave secreta podría crear una vulnerabilidad de seguridad, por lo que NO la modifique bajo ninguna circunstancia.
Vamos a obtener los datos de los usuarios desde Qypher
Se puede recuperar en el array $Qypher.
$Qypher["success"] ← true = Inicio de sesión exitoso, false = Error de inicio de sesión
$Qypher["uuid"] ← Identificador de Qypher para registro de inicio de sesión ( Utilícelo al contactar con Qypher )
$Qypher["Qypher_ID"] ← Identificador único del usuario ( Utilícelo para saber qué usuario inició sesión )
$Qypher["login_time(UTC)"] ← YYYY-MM-DDThh:ii:ssZ ( La hora de inicio de sesión está disponible en UTC )
$Qypher["meetsAgeReq"] ← «Si el usuario cumple el requisito de edad del sitio» (1 = sí, 0 = no). Normalmente 1 en un inicio de sesión correcto. La edad exacta y la fecha de nacimiento nunca se envían.
$Qypher["ageReq"] ← El umbral de edad fijado por el sitio (0 = ninguno)
$Qypher["guardianApproved"] ← Si la edad del usuario está por debajo del umbral de confirmación parental — el valor de needGuardian (13 si no se define; los menores de 13 siempre aplican, independientemente del ajuste) (1/0). Qypher nunca completa un inicio de sesión sin consentimiento de un tutor, así que 1 significa un usuario joven que inició sesión con ese consentimiento
$Qypher["under10"] ← Un indicador aproximado de «menor de 10» (1/0), para cambiar a un texto o diseño adaptado a niños. La edad exacta y la fecha de nacimiento no se envían; cambia solo una vez en el límite de los 10 años, por lo que inicios de sesión repetidos no pueden revelar la fecha de nacimiento.
$Qypher["under13"] ← Un indicador aproximado de «menor de 13» (1/0). Como under10, permite cambiar el texto por franja de edad sin recibir la edad exacta; cambia solo una vez en el límite de los 13 años.
$Qypher["QypherAnyKey"] ← Datos que se desean transferir desde la página de inicio de sesión ( Estos son los datos escritos en el atributo value de id="QypherAnyKey" dentro de apiScript.txt. )
$Qypher["json"] ← Formato JSON de todos los datos ( Utilícelo para procesamiento en JavaScript y más )
Por defecto, los datos proporcionados por Qypher incluyen los elementos anteriores.Si marcas los elementos en datos deseados dentro de QypherDetalles de integración, se proporcionará más información. Sin embargo, los datos que el usuario no haya autorizado o registrado estarán vacíos.
$Qypher["surname"] ← Apellido
$Qypher["givenName"] ← Nombre de pila
$Qypher["nickname"] ← Apodo
$Qypher["email"] ← Correo electrónico
$Qypher["birthday"] ← Fecha de nacimiento
$Qypher["postalCode"] ← Código postal
$Qypher["country"] ← País / Región
$Qypher["area1"] ← Estado / Provincia
$Qypher["area2"] ← Ciudad / Pueblo / Aldea
$Qypher["address"] ← Calle y número
$Qypher["building"] ← Nombre del edificio
$Qypher["room"] ← Nombre de habitación
ej. echo `Hola {$Qypher["givenName"]} {$Qypher["surname"]}, Bienvenido a Qypher.`;
Tenga mucho cuidado al manejar información personal.
Preparemos entorno de producción
En entorno de producción, las claves pública y privada son diferentes de las utilizadas en Sandbox. Simplemente copiar el contenido de Sandbox no hará que entorno de producción funcione.
Configure entorno de producción siguiendo los mismos pasos que en Sandbox.
- Copie todo el contenido de apiScript.txt y péguelo en cualquier lugar de la página de inicio de sesión para entorno de producción.
Si se introducen los datos deseados en el atributo value de <input type="hidden" id="QypherAnyKey" value="">, se podrán transferir después del inicio de sesión.
( Si el contenido ingresado incluye etiquetas HTML, código JavaScript, rutas de archivos u otros similares, se invalidará automáticamente. Si se detecta un valor malicioso, es posible que el uso de Qypher sea restringido. )
- Coloque Archivo de clave secreta para entorno de producción en la ubicación especificada en carpeta para la clave secreta de API dentro de QypherDetalles de integración.
Por favor, colóquelo en el mismo lugar que para Sandbox. No modifique este archivo bajo ninguna circunstancia. Si se modifica, puede ser invalidado por el sistema central de Qypher, y la solicitud de inicio de sesión podría ser rechazada.
No cambie el nombre del archivo. Qypher no podrá identificarlo.
Después de cargarlo, asegúrese de que los permisos del archivo estén correctamente configurados.
Recomendado 604 o 644
*Si utiliza un servidor Windows, no se requieren los permisos “604 / 644” anteriores, pero asegúrese de que el archivo sea accesible por el servidor web (como IIS) con los permisos adecuados.
- Copie todo el contenido de getData.txt y úselo como base para la página posterior al inicio de sesión para entorno de producción.
Ingrese el contenido posterior al inicio de sesión en if($Qypher["success"]){} , y el contenido de error en else{} si falla.
El valor predeterminado tras un inicio de sesión exitoso contiene “Al recargar esta página, deberá volver a iniciar sesión.”.
- Inicie sesión en Qypher, configure Sandbox en Qypher Detalles de integración como entorno de producción y haga clic en actualizar.
Si la página de inicio de sesión muestra “Verificando la ubicación de instalación”, verifique que no esté utilizando la versión de Sandbox, o si utiliza Qypher en varias páginas, asegúrese de estar usando la correcta para ese sitio.
Use Webhook para garantizar la confiabilidad de su información.
Webhook está disponible con el plan Pro y superiores. Después de que un usuario inicie sesión, si la información no se pudo procesar correctamente, use Webhook.
Para los usuarios del plan Pro y superiores, al descargar la API, la carpeta incluye dos archivos: webhook.php y Sandbox_webhook.php. Utilícelos añadiendo lo necesario tal como están.
La obtención de datos es la misma que el método usado en la página posterior al inicio de sesión.
Ingrese la ubicación donde colocó el archivo en Qypher Detalles de integración en Webhook, comenzando con https, y haga clic en actualizar.
Si no utiliza Webhook, deje en blanco Qypher Detalles de integración en Webhook y haga clic en actualizar.
