Documentacion tecnica de la API

Documentación técnica de la API

Si en tu colegio o universidad estan integrando algun sistema propio (el portal de admisiones, el CRM de la institucion, un formulario de inscripcion) con la plataforma, esta página es tu punto de partida. Aquí te explicamos, en terminos sencillos, que es la API, donde vive la documentación oficial y como pedir ayuda cuando algo no cuadra.

En pocas palabras: la plataforma ofrece una API (una forma programática y segura de "hablar" con la plataforma) para que un desarrollador pueda leer y escribir información de contactos, conversaciones, calendarios de citas, pagos, workflows y más, sin tener que entrar manualmente a la interfaz web.

Importante para instituciones con integraciones antiguas: la versión 1 de la API (V1) dejo de tener soporte el 31 de diciembre de 2025. Si tu equipo técnico construyo algo hace tiempo, es muy probable que siga funcionando, pero ya no recibira soporte ni correcciones sobre esa versión. Si estan planeando una integración nueva o una migración, lo correcto es usar la V2. Te recomendamos revisar el artículo Integraciones Privadas, que es la forma más simple y segura de empezar.

Las versiones anteriores de la documentación se mantienen disponibles como referencia, así que si tu institucion depende de una integración existente, pueden seguir consultandola mientras planean el salto a la versión más reciente sin prisa.

Donde esta la documentación oficial

Toda la referencia técnica de la API (endpoints, parametros, ejemplos de peticion y respuesta) vive en un solo lugar: https://marketplace.gohighlevel.com/docs/. Si tu equipo de desarrollo tenia guardado un enlace a la documentación antigua de Stoplight, es buen momento para actualizarlo, porque quedara descontinuada en los proximos meses.

Una comodidad que vale la pena conocer: la documentación ahora tiene un selector de versión. Esto le permite a quien este desarrollando la integración ver exactamente los endpoints y el formato de una versión específica de la API, en vez de mezclar información de distintas versiones. Es especialmente útil si tu institucion ya tiene una integración funcionando y solo quiere confirmar que no rompera nada al revisar la documentación.

Como usar el selector de versión (paso a paso)

1. Abre la documentación oficial de la API.
2. Usa el selector de versión (arriba, en la barra de navegacion) para elegir la versión que tu desarrollador necesita consultar.
3. Revisa los endpoints, parametros y ejemplos de esa versión específica.
4. Si tienen una integración en producción, sigan usando la versión con la que fue construida hasta que decidan migrar de forma planeada.
5. Si estan por construir algo nuevo, es buena idea revisar la versión más reciente antes de empezar.

Cambiar de versión en la documentación no afecta nada de lo que ya tienen funcionando — es solo una forma más clara de consultar la referencia correcta.

Si algo no funciona: como pedir ayuda

Es normal que durante una integración surjan dudas. Aquí la ruta correcta según el tipo de problema:

• Si tienen un bug real de la API (la configuración esta correcta pero el error persiste): pueden reportarlo en https://developers.gohighlevel.com/support
• Si tienen una duda técnica o quieren aprender de otros desarrolladores: unanse a la comunidad de Slack para desarrolladores en https://developers.gohighlevel.com/join-dev-community — es un buen lugar para preguntar y ver como otras instituciones resolvieron problemas parecidos.
• Si quieren mantenerse al día: se organiza una llamada mensual para desarrolladores (Developer Council), el penultimo viernes de cada mes. El calendario esta en https://www.gohighlevel.com/events

Un punto importante: el equipo de soporte no revisa el código de tu integración ni da consultoria personalizada. Para eso esta la comunidad de desarrolladores y, si el presupuesto lo permite, un desarrollador o agencia especializada.

¿Qué tanto acceso tenemos según nuestro plan?

Esto suele generar confusion, así que va directo: el acceso básico a la API viene incluido en los planes Starter y Unlimited. Si tu institucion esta en el plan Agency Pro, tienen acceso avanzado, que incluye funcionalidades adicionales de OAuth 2.0 y llaves de API a nivel agencia (útiles si administran varias sedes o campus desde una sola cuenta).

Límites de uso (rate limits) — para que tu desarrollador lo tenga presente

Para que el sistema sea estable para todos, se limita cuantas peticiones puede hacer una integración:

• Máximo por rafaga: 100 peticiones cada 10 segundos, por cada app y por cada sede/cuenta.
• Máximo diario: 200,000 peticiones por día, por cada app y por cada sede/cuenta.

Si tu institucion tiene varios campus o sedes conectados como cuentas distintas, cada una cuenta con su propio límite — no se comparten entre si. Tu desarrollador puede monitorear cuanto se ha consumido revisando estos datos en cada respuesta de la API: X-RateLimit-Limit-Daily, X-RateLimit-Daily-Remaining, X-RateLimit-Remaining, entre otros.

Preguntas frecuentes

¿Para que sirve realmente esta API, explicada sin tecnicismos? Es el puente que le permite a un sistema externo (por ejemplo, el formulario de admisiones de tu página web, o un sistema academico) mandar y recibir información automáticamente, sin que alguien tenga que capturar los datos a mano.

¿Seguimos pudiendo usar una integración vieja construida con la API V1? Probablemente siga funcionando, pero sin soporte ni actualizaciones. Si es algo critico para tu institucion (por ejemplo, el flujo de inscripcion), vale la pena planear la migración a V2 con tiempo, no de emergencia.

¿Cuál es la forma más fácil y segura de conectar un sistema propio con la plataforma? Para la mayoria de los casos (una sola sede, una herramienta interna), lo más simple es usar una Integración Privada — no requiere que un usuario "inicie sesión", solo un token que tu generas desde configuración. Si van a construir algo que se instale en muchas cuentas distintas (como una app del Marketplace), ahi si conviene usar OAuth 2.0.

¿Cuáles son los límites de peticiones que debemos cuidar? 100 peticiones cada 10 segundos y 200,000 al día, por cuenta. Para la mayoria de instituciones esto es más que suficiente, incluso en temporada alta de inscripciones.

¿El soporte técnico nos puede ayudar a programar la integración? No directamente — ellos resuelven bugs de la plataforma, no problemas de código de tu proyecto. Para eso, la comunidad de desarrolladores o un desarrollador de confianza son el mejor camino.

¿Dónde consultamos la documentación completa y actualizada? Siempre en https://marketplace.gohighlevel.com/docs/ — esa es la fuente oficial y la que se mantiene al día.

¿Existe una versión 3 de la API? Todavia no esta disponible publicamente. esta en desarrollo como la siguiente gran actualización. Si tu institucion esta planeando algo a largo plazo, vale la pena seguir revisando los anuncios oficiales.

Resumen: a quien contactar según el caso

1. Encontraron un bug de la plataforma: https://developers.gohighlevel.com/support
2. Tienen una duda técnica o quieren aprender de la comunidad: https://developers.gohighlevel.com/join-dev-community