Saltar al contenido principal
Version: v1.11.3

Guía de integración

Esta guía recorre el flujo completo de la consola integrada, desde el alta de una web hasta la carga del panel en tu plataforma.

Antes de empezar

Necesitas credenciales de integrador activas. Si aún no las tienes, solicita acceso y te acompañaremos durante el onboarding.

Requisitos previos

Antes de empezar, asegúrate de que dispones de:

  • Una clave de API de integrador para el entorno en el que vas a trabajar, staging o producción.
  • Un backend desde el que realizar las llamadas. La clave nunca debe viajar al navegador.
  • Un espacio en tu interfaz donde renderizar un iframe a pantalla completa.

Entornos

EntornoURL baseUso
Staginghttps://api.staging.lawwwing.com/Desarrollo y validación de la integración.
Producciónhttps://api.lawwwing.com/Operativa real, una vez validada la integración.

Cada entorno tiene su propia clave de API y no son intercambiables.

Paso 0. Verifica la conectividad

Antes de nada, confirma que tus credenciales funcionan:

curl -X GET "https://api.lawwwing.com/api/integrator/ping/" \
-H "Authorization: Integrator-Key ${TOKEN}" \
-H "Content-Type: application/json"

Una respuesta {"message": "pong"} confirma que la autenticación es correcta.

Paso 1. Da de alta la web de tu cliente

curl -X POST "https://api.lawwwing.com/api/integrators/sites/" \
-H "Authorization: Integrator-Key ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"url": "client.example.com"
}'

La respuesta incluye el campo site, el identificador único de la web.

Guarda el site_id

Almacena el site_id junto al registro del cliente en tu base de datos. Lo necesitarás en todas las operaciones posteriores.

Paso 2. Activa la suscripción

Asocia a la web el plan y los módulos que corresponden a la oferta que tu cliente ha contratado:

curl -X POST "https://api.lawwwing.com/api/integrators/sites/{site_id}/subscription/" \
-H "Authorization: Integrator-Key ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"tier": "growth",
"interval": "monthly",
"modules": [
{"name": "extra_language", "quantity": 2}
]
}'

Consulta los valores admitidos de tier, interval y modules en la referencia de la API, incluido el catálogo de módulos y cómo se interpreta quantity en cada uno.

Paso 3. Genera la sesión del panel

Cada vez que tu cliente abra su panel, solicita una URL de sesión nueva:

curl -X GET "https://api.lawwwing.com/api/integrators/sites/{site_id}/embed/" \
-H "Authorization: Integrator-Key ${TOKEN}" \
-H "Content-Type: application/json"
{
"site": "61e21ed7-2770-4fa8-baad-53564ee7651d",
"embed_url": "https://app.lawwwing.com/d/61e21ed7-2770-4fa8-baad-53564ee7651d/?embed=1&token=cd99d2...",
"embed_token": "cd99d2..."
}
Solicita siempre un token nuevo

Los tokens de sesión tienen una validez limitada por motivos de seguridad. No los almacenes ni los reutilices: solicita una embed_url nueva en cada carga del panel.

Paso 4. Renderiza el panel

Usa el valor de embed_url como src del iframe:

<iframe
src="https://app.lawwwing.com/d/61e21ed7-2770-4fa8-baad-53564ee7651d/?embed=1&token=cd99d2..."
style="width: 100%; height: 100vh; border: none;"
></iframe>
Recomendaciones de presentación
  • Reserva una altura amplia (100vh o el alto del contenedor) para evitar dobles barras de desplazamiento.
  • Genera la embed_url en el servidor y entrégala a tu frontend justo antes de montar el iframe.
  • Si tu cliente cierra y vuelve a abrir el panel, repite el Paso 3.

Gestión del ciclo de vida

Una vez la web está operativa, controlas el resto del ciclo desde tus propios flujos:

SituaciónOperación
El cliente quiere consultar el estado de su servicioConsultar la suscripción
El cliente cancela la renovaciónCancelar la suscripción
El cliente quiere revertir la cancelación antes del fin del periodoReactivar la suscripción
Baja definitiva del servicioTerminar la suscripción

Buenas prácticas

  • Protege la clave de API - Guárdala en tu gestor de secretos y realiza las llamadas siempre desde el servidor.
  • Comprueba antes de crear - Antes de dar de alta una web o una suscripción, verifica si ya existe en tu propio registro.
  • Controla los errores - Gestiona las respuestas 401, de credenciales, y 400, de validación, para dar mensajes claros a tus clientes.
  • Valida en staging - Reproduce todos los escenarios (alta, cambio de plan, cancelación y baja) antes de pasar a producción.

¿Necesitas ayuda?

Durante la integración dispones de un canal directo con nuestro equipo técnico.

💬 Hablar con el equipo