Introducción
Este paso a paso te servirá como guía para integrar la API de DataCRM con tu sitio web. A lo largo de este proceso, aprenderás a gestionar usuarios, autenticar solicitudes, y realizar peticiones GET y POST de manera segura y efectiva. Al final, serás capaz de enviar y recibir datos entre tu sitio web y el CRM de forma fluida.
Paso 1: Ingresa a la sección de login
Ingresa a <url documentacion> y navega hacia la sección de login. Aquí reemplaza la URL por la de DataCRM y asegúrate de utilizar el username correcto. Un ejemplo sería:
username=admin
Paso 2: Crea un usuario en el CRM
Accede a DataCRM y crea un usuario. Este usuario será el encargado de realizar las peticiones a través de la API. Es importante que asignes los permisos necesarios para que pueda interactuar con los módulos del sistema.
Paso 3: Ajustes de preferencias en el CRM
Dirígete a la sección de "Preferencias" para ajustar configuraciones necesarias que afectarán el comportamiento de la API.
Es aquí donde puedes personalizar cómo se manejarán las peticiones y los permisos del usuario creado.
Paso 4: Obtener clave de acceso (Token y AccessKey)
Debes copiar la clave de acceso que te proporciona el CRM. Esta clave será fundamental para autenticar las solicitudes que realices.
Añade la clave de acceso (Token + AccessKey) en el primer GET Request que realices.
Envía esta clave utilizando el algoritmo MD5 para mayor seguridad.
Como respuesta, recibirás un sessionName, que será utilizado para todas las peticiones futuras.
Paso 5: Enviar usuario y contraseña
En lugar de usar el token y la clave, también puedes simplemente enviar el usuario y la contraseña para autenticarte en el CRM.
Esto dependerá de cómo esté configurada tu implementación de seguridad.
Paso 6: Creación del archivo backend
Es necesario crear un archivo en el backend de tu aplicación. Este archivo se encargará de gestionar las peticiones y respuestas hacia el CRM. Ten en cuenta que:
Las peticiones desde dominios distintos no serán aceptadas.
Solo se aceptarán peticiones desde el dominio en el cual fue solicitada la integración.
Paso 7: Crear el acceso con Token y AccessKey
Una vez que tienes el token y el accessKey, puedes crear el acceso. Un ejemplo de petición correcta sería algo similar a:
Ejemplo de petición correcta:
Paso 8: Crear formulario HTML con JavaScript
Si es necesario, crea un formulario en HTML con su correspondiente JavaScript, apuntando hacia el CRM para realizar el envío de datos.
Este formulario se encargará de recoger la información del usuario o cliente que se desee registrar y enviarla al CRM a través de la API.
Paso 9: Validar peticiones y módulos
Es importante que revises la lista de peticiones que actualmente están documentadas en el CRM. En el método lista de módulos puedes obtener una lista de los módulos que están activos y con los cuales puedes realizar peticiones.
Paso 10: Realizar peticiones GET
Una vez configurado el acceso, todas las peticiones GET funcionarán de manera similar. Sigue los mismos pasos indicados y no deberías tener mayores complicaciones.
Estas peticiones son útiles para obtener información del CRM de manera rápida.
Paso 11: Realizar peticiones POST
Las peticiones POST suelen requerir datos adicionales. Por ejemplo, al crear un cliente, debes incluir el id del administrador (generalmente 1). Este id puede ser encontrado en la URL al revisar los usuarios en el CRM.
También puedes añadir datos adicionales usando el método de información de módulos. Aquí encontrarás los nombres de los campos disponibles y los valores válidos si es que el campo es tipo lista.
Además, existe un método para creación rápida donde solo es necesario enviar los campos y módulos que se van a crear.
Esperamos que este artículo haya sido de gran utilidad. Si tienes alguna duda o sugerencia, te invitamos a que nos escribas en nuestro chat y con gusto estaremos allí para ayudarte ¡Ten un buen día!
