Hoy quiero compartir mi experiencia desarrollando una API personalizada para WHMCS, que permite consultar si un cliente existe en el sistema utilizando un dato de entrada, como su ID de cliente, DNI o CUIT. Este proyecto surgió como parte de una solicitud para integrarse con un script externo que debía consultar esta información a través de una API desde una central telefónica.
El Problema y su Análisis
El requerimiento era bastante simple: validar si un cliente existía en WHMCS y devolver los datos básicos del mismo, como su nombre, apellido y correo electrónico. La idea era permitir que un sistema externo, en este caso una central telefónica, pudiera consultar esta información mediante una solicitud a la API, facilitando la identificación del cliente durante las llamadas.
La Solución: Una API de Consulta de Clientes
Para resolver el problema, desarrollé una API personalizada que responde a las consultas en el siguiente formato JSON:
{
"result": "success",
"totalresults": 1,
"clients": [
{
"client_id": *****,
"firstname": "sergio",
"lastname": "rios",
"email": "******@gmail.com"
}
]
}
La API acepta como parámetros el ID de cliente, el DNI o el CUIT, y devuelve una respuesta indicando si el cliente existe y, en caso afirmativo, proporciona sus datos. Si el cliente no es encontrado, la respuesta sería diferente, reflejando que no se obtuvieron resultados.
¿Qué es una API y cómo se consume?
Una API (Interfaz de Programación de Aplicaciones) es un conjunto de funciones y protocolos que permiten la comunicación entre diferentes aplicaciones. En el caso de esta API para WHMCS, se trata de una forma de exponer ciertos datos del sistema (como los clientes) para que puedan ser utilizados por otros servicios externos.
Para consumir la API, puedes utilizar herramientas como Insomnia o Postman, que son populares para probar y realizar solicitudes HTTP de manera sencilla. A continuación, te explico cómo hacerlo:
- Configuración de la solicitud: En Postman o Insomnia, crea una nueva solicitud del tipo GET o POST, dependiendo de cómo hayas configurado la API. Especifica la URL de tu endpoint y los parámetros requeridos (ID de cliente, DNI o CUIT).
- Autenticación: Si tu API requiere autenticación, configura los encabezados necesarios o el token de acceso.
- Ejecuta la solicitud: Al enviar la solicitud, la herramienta te mostrará la respuesta en formato JSON, permitiéndote verificar si la API responde correctamente con la información del cliente.
Todo esto tuve que documentarlo explicando un poco los parámetros necesarios, proporcionando autenticación necesaria, y explicando el funcionamiento.
Pueden encontrar la documentación si les interesa en mi cuenta de hithub.
Conclusión
Crear esta API me permitió reforzar el concepto de cómo funciona una API y cómo integrarla con sistemas externos. Aunque era una funcionalidad sencilla, es un buen ejemplo de cómo podemos exponer información de manera segura y estructurada, permitiendo que otras aplicaciones consuman los datos necesarios para operar.