Aliados Estratégicos
Cores y Softwares
Cores y softwares
mulaWare
Ver Más
Documentación
Alta y Segmentación de Usuarios
Bienvenido a nuestra plataforma y API Q-Detect.
Para optimizar los beneficios operativos y el cumplimiento normativo, es crucial que el cliente defina todas las áreas y cargos de los usuarios que utilizarán los servicios. Esto permitirá identificar y asignar las listas que atiendan las necesidades específicas de cada área.
Segmentación de Áreas y Cargos Defina todas las áreas y cargos de los usuarios que utilizarán los servicios.
Las áreas operativas pueden incluir, entre otras:
- Prevención de Lavado de Dinero
- Recursos Humanos
- Proveedores
- Adquisiciones
- Operaciones
Proceso de Alta de Clientes y Usuarios
- Alta de Empresas: Registre sus empresas en Q-Detect para segmentar listas según país, área y cargo.
- Definición de Áreas y Cargos: Genere las áreas y cargos de todos sus usuarios en la sección ‘ID Seguridad’.
- Registro de Usuarios: Registre el nombre completo de todos los usuarios.
- Despliegue y Segmentación: La plataforma muestra listas segmentadas por país y área, adaptadas a distintos tipos de riesgo.
Beneficios
- Precisión en Consultas: Consultas más precisas y relevantes.
- Cumplimiento Normativo: Asegurar cumplimiento de normativas locales y globales.
- Gestión Eficiente: Facilitar administración de listas y riesgos específicos.
- Incorporación de Plataformas: Permitir integración con otras plataformas y softwares.
- Para cualquier duda, solicite una reunión virtual con nuestro equipo. Estamos disponibles para asegurar una configuración y uso óptimo de Q-Detect.
Introducción
¿Qué es la Q-Detect API?
Es un servicio web que tiene como objetivo facilitar la interconexión entre dos máquinas o aplicaciones mediante una interfaz para que estas se comuniquen entre sí.
Cuando se utiliza un web service (como Q-Detect API), un cliente manda una solicitud a un servidor, desencadenando una acción por parte de este. A continuación, el servidor devuelve una respuesta al cliente.
El Q-Detect API
además de proveer a los Clientes, y Softwares/Plataformas la capacidad de consumir el servicio de búsqueda de Servicios Quién es Quién, permite que desde esta se puedan crear cuentas para sus clientes (creación, edición, búsqueda) de manera directa y sin intervención de terceros.
Permite realizar la conexión bajo un nuevo esquema de seguridad
El Q-Detect API permite realizar la conexión bajo un nuevo esquema de seguridad tanto con nuestros Clientes como con Softwares/Plataformas brindando así autonomía total en la gestión y administración desde la plataforma de Q-Detect.
El Q-Detect API involucra un proceso de pasos secuenciado para poder realizar la conexión entre las diferentes plataformas que quieren consumirlo, a continuación, se listan los procesos de manera general que se involucran como parte de la activación y consumo del Q-Detect API:
Creación de una cuenta por el administrador de la plataforma Q-Detect, para iniciar el registro de su usuario:
Para iniciar operaciones en la plataforma de Q-Detect es necesario tener una cuenta misma que deberá ser creada por el Administrador de la plataforma Q-Detect, esto como el paso final del proceso de suscripción. Una vez creado su usuario, nuestros Clientes, y Softwares/Plataformas podrán realizar su activación.
Activar cuenta y crear para el usuario administrador de Softwares/Plataformas
Después de que el acceso fuera creado por el administrador de Q-Detect y recibir un correo electrónico de notificación, es necesario que se cree la contraseña y se concluya la activación para poder acceder al portal de Q-Detect.
Generar un token/ID secreto junto con mi Cliente ID.
Con el usuario y contraseña listos, es necesario acceder a la plataforma, para poder obtener el cliente ID y generar un ID secreto.
El Cliente ID y el ID Secreto son parte de los nuevos elementos de seguridad que se incluyen como parte de la activación de cuentas de nuestros Clientes y Software/Plataforma.
Cliente ID: Este es un identificador único como cliente, se genera automáticamente desde la
plataforma una vez que se registra los Clientes o Softwares/Plataformas.
ID Secreto: Este es una segunda llave de identificación, esta se genera directamente el usuario
administrador del Cliente o Softwares/Plataformas una vez que realice su activación. El ID Secreto se asigna al cliente por servicio contratado, significa que por cada servicio contratado puede tener un ID Secreto diferente.
TOKEN:Es el tercer elemento de seguridad que se incluye como parte del proceso de activación.
Este debe de generarse previo a la invocación de los servicios de consulta o creación de usuarios
y tiene como objetivo acompañar cada llamada vía Q-Detect API. El token se genera a partir del
Cliente ID y el ID Secreto.
Consumir el servició de generación de token.
- Se necesitarán los datos de cliente ID y el ID secreto de la cuenta. Obtendremos como respuesta
un estatus 200 con el token generado para poder realizar las siguientes peticiones. - Construir la solicitud de búsqueda.
Al construir la solicitud de búsqueda, deben llenarse los parámetros sobre los cuales el API
trabajará, algunos de ellos son: name, rfc. - Consumir el método find.
Lanzar la solicitud de búsqueda, para obtener resultados.
Formato de entrega: JSON
Activación de Cuenta por parte del Cliente
Este proceso inicia una vez que la suscripción se ha realizado, el administrador del portal de Q-Detect crea la cuenta y desde la plataforma se asigna una contraseña temporal de la cuenta. Así mismo, para el usuario registrado le llegará una notificación vía correo electrónico, con el objetivo de que pueda iniciar su proceso de activación.
Correo de Bienvenida con acceso a crear una contraseña para la cuenta.
Con este mail, el cliente tras dar click en el botón de crear contraseña podrá definir una para su acceso. Una vez realizado este paso, podrá acceder a la plataforma en la página de ingreso.
Página de ingreso a la plataforma Q-Detect
Una vez dentro de la plataforma, el usuario encontrará su nombre en la parte superior derecha, este funcionará como un menú desplegable. El cual mostrará la opción de ID Seguridad dentro de las opciones.
Opción ID Seguridad
Aquí se encuentra lo necesario para poder utilizar la API, ofrecida en Q-Detect. El Cliente ID y la posibilidad de crear un ID Secreto.
ID Cliente
ID Secreto (No olvidemos copiar el código)
Es necesario contar con un ID Cliente y el ID Secreto para poder realizar la generación del Token de seguridad. Este proceso permite realizar por los medios más seguros la autenticación e identificación de los usuarios que realizan la invocación de los servicios de QeQ mediante el Q-Detect API.
Estructura de respuesta al consumir API
Al consumir el API de Q-Detect, siempre se obtendrá un objeto JSON como respuesta, la estructura general es la siguiente:
Respuesta exitosa
Todas las respuestas, contendrán la propiedad “success”, la cual indicará de manera rápida, si nuestra petición se ejecutó correctamente, o si se encontró algún problema.
Respuesta no exitosa
En caso de recibir un valor negativo, obtendremos un mensaje corto explicando el problema, dentro de la propiedad “status”.
Los resultados específicos del método “find”, estarán dentro del arreglo “data”
A continuación, se lista los métodos del portafolio de servicios de Q-Detect API disponibles para su contratación
Autenticación: Generación token
Método: GET
Parámetros
client_id Obligatorio
type: string [url param]
Headers
Bearer token Obligatorio
(secret id)
Respuesta: API
Token string
Ejemplo de respuesta
Operaciones de Clientes – Software / Plataforma Búsqueda
Método: GET
Headers Bearer
token Obligatorio
(API TOKEN)
Parámetros
client_id Obligatorio
Tipo de dato: string
Username Obligatorio
Tipo de dato: string
Username de la cuenta con la que se realizará la búsqueda
Name Condicional
Tipo de dato: string
Nombre de la persona física o moral a buscar. Para el caso de personas físicas, se deberá incluir el nombre y apellidos, separados por un espacio en blanco Ej. “Andres Manuel López Obrador”
RFC Condicional
Tipo de dato: string
Parámetro para incluir el RFC de la persona física o moral a buscar.
Al buscar a Andres Manuel López Obrador, en nuestro objeto JSON de resultado, veremos que nos lanza múltiples valores. Cada resultado tiene especificado el nombre de la lista a la que pertenece.
Respuesta:
Como resultado obtendremos el objeto JSON, con datos de los resultados. Es posible que una
búsqueda arroje múltiples valores, si la persona buscada se encuentra en varias listas.
