Saltar al contenido principal
Version: v1.12.1

Guía de integración

Esta guía recorre el flujo de la API de Audit: autenticarte, lanzar el análisis de una web y recuperar el informe cuando el trabajo termina.

Antes de empezar

Necesitas un token de API activo. Si aún no lo tienes, solicita acceso y te acompañaremos durante el onboarding.

La referencia completa de parámetros y respuestas está en audit.lawwwing.com/docs. Aquí documentamos el flujo que usarás en un caso de prospección.

Requisitos previos

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

  • Un token de API emitido por Lawwwing.
  • Un backend desde el que realizar las llamadas. El token nunca debe viajar al navegador.
  • Un identificador de la web a analizar, dominio o URL, asociado a tu prospecto.

URL base

EntornoURL base
Producciónhttps://audit.lawwwing.com/api/v1

Todas las rutas usan barra final (/jobs/, no /jobs). Los identificadores de trabajo son UUIDs y las respuestas son JSON.

Autenticación

Todas las solicitudes se autentican con la cabecera Authorization:

CabeceraValor
AuthorizationToken <your_token>
Content-Typeapplication/json
Protege tu token

El token identifica a tu organización y consume tu cupo de auditorías. Utilízalo exclusivamente desde tu backend. Si falta o no es válido, la API responde 401 Unauthorized.

Paso 0. Verifica la conectividad

Confirma que tus credenciales funcionan:

curl https://audit.lawwwing.com/api/v1/ping/ \
-H "Authorization: Token ${TOKEN}"

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

Paso 1. Crea el trabajo de auditoría

Envía la web del prospecto. Si no indicas protocolo, la API antepone https://.

curl -X POST https://audit.lawwwing.com/api/v1/jobs/ \
-H "Authorization: Token ${TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"target": "prospecto.example.com"
}'
{
"id": "00000000-0000-0000-0000-000000000000",
"status": "pending",
"target": "https://prospecto.example.com",
"created": "2026-07-02T12:00:00Z",
"result": {}
}
Guarda el id

Almacena el identificador del trabajo junto al registro del prospecto. Lo necesitas para consultar el estado y el resultado.

El campo pipeline es opcional. Si lo omites, se usa el pipeline por defecto de tu cuenta. Para conocer los pipelines disponibles y qué analiza cada uno, habla con nuestro equipo durante el onboarding.

El campo sync también es opcional y vale false por defecto. Con true, el análisis se ejecuta durante la propia petición. En producción recomendamos el flujo asíncrono de esta guía.

Paso 2. Consulta el estado hasta que termine

El análisis no es inmediato. Consulta el trabajo hasta que el estado sea terminal:

curl https://audit.lawwwing.com/api/v1/jobs/00000000-0000-0000-0000-000000000000/ \
-H "Authorization: Token ${TOKEN}"
pending


started
├────────────► processed

└────────────► error
EstadoSignificado
pendingEl trabajo se ha aceptado y está en cola.
startedEl análisis se está ejecutando.
processedEl análisis ha terminado y el campo result contiene el informe.
errorNo se ha podido completar. result puede incluir el detalle del error.

processed y error son estados finales: el trabajo no volverá a cambiar.

Ritmo de consulta

La mayoría de auditorías terminan en menos de un minuto. No lances peticiones en bucle cerrado: deja un intervalo entre consultas y detente cuando el estado sea processed o error.

Paso 3. Usa el informe

Cuando el estado es processed, el campo result contiene el diagnóstico en JSON. Su estructura depende del pipeline configurado para tu cuenta.

Con ese resultado puedes, por ejemplo:

  • Mostrarlo en la ficha del lead de tu CRM.
  • Generar un resumen para el equipo comercial antes de la reunión.
  • Decidir si el prospecto entra en un flujo de alta o de seguimiento.
Detalle de result

La forma exacta del objeto result se define con tu pipeline. Consulta la referencia de la API y confirma el formato con nuestro equipo durante el onboarding.

Límites y errores

CódigoSignificado
200 / 201La operación se ha completado correctamente.
400Los datos enviados no son válidos. Revisa target u otros campos.
401Falta la cabecera Authorization o el token no es válido.
404El trabajo no existe o no pertenece a tu cuenta.
429Has superado el cupo de auditorías.

Un error de validación típico:

{
"target": [
"Enter a valid URL or domain."
]
}
Si recibes un 429

Implementa una espera progresiva antes de reintentar. Si necesitas un cupo mayor, habla con nuestro equipo durante el onboarding.

Buenas prácticas

  • Protege el token — Guárdalo en tu gestor de secretos y realiza las llamadas siempre desde el servidor.
  • Asocia cada trabajo a un prospecto — Guarda el id del trabajo junto al lead para poder recuperar el informe más tarde.
  • No reutilices trabajos — Cada web y cada análisis nuevo deben crear un trabajo distinto.
  • Controla processed y error — Ambos estados cierran el ciclo; no asumas que el análisis siempre termina bien.
  • Usa el panel cuando no haga falta automatizar — Para una demo o una reunión puntual, el panel de partners es suficiente.

Referencia completa

Esta guía cubre el flujo de integración. Para el detalle de cada endpoint, parámetro y respuesta:

¿Necesitas ayuda?

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

💬 Hablar con el equipo