Saltar al contenido principal

Desarrolladores

Ejemplos

Patrones listos para copiar de las integraciones más habituales con Inkspectra API.

Desarrolladores

Analizar desde tu backend

Envía texto o PDF del contrato y guarda el analysisId devuelto.

curl -X POST "https://alpha.inkspectra.com/_api/v1/analyses" \
  -H "Authorization: Bearer fpk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Service Agreement",
    "sourceType": "text",
    "text": "This agreement governs software services between the parties..."
  }'

Desarrolladores

Polling de finalización

Consulta GET /v1/analyses/{analysisId} hasta completed y recupera el resultado.

const statusRes = await fetch(`https://alpha.inkspectra.com/_api/v1/analyses/${analysisId}`, {
  headers: { Authorization: "Bearer fpk_test_YOUR_KEY" },
});
const { status }: { status: string } = await statusRes.json();
// Repeat until status === "completed"

Desarrolladores

Guardar como contrato

Persiste un análisis completado como contrato reutilizable (ctr_*) con POST /v1/contracts.

const res = await fetch("https://alpha.inkspectra.com/_api/v1/contracts", {
  method: "POST",
  headers: {
    Authorization: "Bearer fpk_test_YOUR_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ analysisId }),
});

const { contractId, versionNumber }: { contractId: string; versionNumber: number } = await res.json();

Desarrolladores

Comparar dos contratos

Envía dos handles de análisis o contrato para resaltar diferencias relevantes.

const res = await fetch("https://alpha.inkspectra.com/_api/v1/comparisons", {
  method: "POST",
  headers: {
    Authorization: "Bearer fpk_test_YOUR_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    left: { analysisId: "ana_LEFT" },
    right: { analysisId: "ana_RIGHT" },
  }),
});

const { comparisonId, status, resolved }: {
  comparisonId: string; status: string; resolved: { left: object; right: object };
} = await res.json();

Desarrolladores

Sesión embebida

Crea sesión widget cuando el usuario final necesite UI interactiva — ver canal Widget.

Documentación parcial

Desarrolladores

Flujo con webhook

Evita polling manejando analysis.completed y verificando X-Inkspectra-Signature.

Documentación parcial

Patrones

Cómo integran los equipos

Elige la superficie que encaje con tu UX: solo API, UI embebida o eventos.

Solo backend

Analiza y haz poll desde tu servicio; muestra resultados en tu UI.

UI embebida

Combina análisis API con sesiones widget para revisión humana.

Orientado a eventos

Usa webhooks para disparar flujos cuando terminen análisis.

Prueba con seguridad primero

Usa claves fpk_test_* y la guía sandbox antes de solicitar acceso live.