IA para negocios

Documentación de la API pública de HellouOne en OpenAPI 3.1 y del SDK en dos idiomas

La API pública de HellouOne ahora está documentada como una especificación OpenAPI 3.1, y el SDK de HellouOne tiene documentación en dos idiomas. Lanzado el 1 de octubre. Qué significa para los desarrolladores que integran HellouOne con sus propios sistemas.

Ilustracion de una pagina de documentacion de API con bloques de codigo y un selector de dos idiomas, conectada por un icono de enchufe a una bandeja de HellouOne, con un desarrollador en una laptop

El 1 de octubre, HellouOne publicó dos cosas que los desarrolladores venían pidiendo: la API pública documentada como una especificación OpenAPI 3.1, y la documentación del SDK de HellouOne en dos idiomas. Ninguna cambia lo que hace la API. Ambas cambian qué tan rápido un desarrollador pasa de leer sobre ella a llamarla, que en un proyecto de integración es la mayor parte del trabajo.

Por qué importa OpenAPI 3.1

OpenAPI es la forma estándar de describir una API HTTP: cada endpoint, sus parámetros, la forma de sus solicitudes y respuestas, y su autenticación, en un solo archivo legible por máquinas. La versión 3.1 alinea el lenguaje de esquemas con JSON Schema, lo que hace que la especificación sea utilizable por la generación actual de herramientas. En la práctica, un documento OpenAPI 3.1 le da a un desarrollador tres cosas desde el primer día:

  • Documentación de referencia generada desde la especificación y que por lo tanto coincide con la API, en vez de una página escrita a mano que se desactualiza.

  • Generación de código cliente. La mayoría de los lenguajes tiene un generador que convierte la especificación en un cliente tipado, así llamar a HellouOne desde un backend se vuelve cuestión de importar un paquete en vez de escribir solicitudes a mano.

  • Pruebas de contrato y simulación. Los equipos pueden validar su integración contra la especificación antes de tocar producción, y simular la API en sus propias suites de pruebas.

Hay un cuarto beneficio, más nuevo. Los agentes de IA para programar leen bien las especificaciones OpenAPI. Un desarrollador que trabaja con un asistente puede señalarle la especificación y obtener llamadas correctas, lo que acorta bastante la primera tarde de una integración.

Documentación del SDK en dos idiomas

El SDK de HellouOne envuelve la API para los desarrolladores que prefieren llamar métodos en vez de construir solicitudes. Su documentación ahora existe en dos idiomas, lo que refleja dónde están los clientes de HellouOne: equipos de desarrollo en América Latina y Estados Unidos, que muchas veces trabajan en español e inglés en el mismo proyecto. Un desarrollador en Bogotá y uno en Miami pueden leer la misma guía en el idioma en que piensan, y compartir enlaces a las mismas páginas.

Qué suelen construir los desarrolladores

Las integraciones que más aparecen entre los clientes de HellouOne son prácticas. Sincronizar contactos y etiquetas desde un CRM o una base de datos interna de clientes, para que la bandeja y los agentes IA sepan quién escribe. Devolver los resultados de las conversaciones a un sistema de registro, como una cita agendada o un lead calificado. Disparar una plantilla de WhatsApp desde un evento interno, como un pedido que se despacha o un pago que falla. Y reportes: llevar los datos de conversaciones y sentimiento a los tableros que el negocio ya usa. Con una especificación y un SDK, cada una de estas es una tarea bien definida y no un proyecto de investigación.

La calidad de la documentación también cambia quién puede hacer la integración. Con una especificación y un cliente tipado, un equipo pequeño sin un ingeniero de integraciones dedicado puede conectar HellouOne con su CRM en una tarde, y una agencia que incorpora varios clientes puede reutilizar el mismo código cliente entre cuentas. La documentación del SDK en dos idiomas reduce la probabilidad de que un detalle se pierda en la traducción entre un equipo de operaciones que habla español y un contratista que habla inglés, que es una forma común de proyecto en la región.

Cómo usarlo en HellouOne

Empieza con el documento OpenAPI 3.1 en one.hellou.ai/docs, cárgalo en tu herramienta de API preferida para explorar los endpoints, y genera un cliente para tu lenguaje si el SDK no lo cubre. Lee la documentación del SDK en el idioma que prefiera tu equipo. Autentícate con tus credenciales de API de HellouOne desde el administrador, haz primero una llamada de solo lectura y luego conecta las operaciones de escritura que necesite tu integración. Si también usas los conectores de los agentes IA de HellouOne, la API es el complemento: los conectores permiten que el agente IA entre a tus sistemas durante una conversación, mientras que la API permite que tus sistemas entren a HellouOne. Juntos hacen que HellouOne sea parte de tu stack y no una herramienta aparte.

¿Listo para verlo en acción?
Algunos de nuestros clientes

Empresas que ya operan con hellou

Ver todos los casos →
FuncionesPreciosCómo funcionaCasosRecursosConversemos