Saltar al contenido principal

Desarrolladores

Inicio rápido

Obtén una API key de prueba, ejecuta tu primer análisis, consulta resultados y opcionalmente abre una sesión de revisión.

Paso 1

Obtén una clave API de test

Ve a Configuración de organización → Desarrolladores → Claves API. Crea una clave con prefijo fpk_test_*, modo test. Se muestra solo una vez — guárdala de forma segura.

Paso 2

Ejecuta tu primer análisis

POST /v1/analyses con texto, URL o PDF y tu clave API. Devuelve 202 con un handle ana_* y un enlace para hacer polling.

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..."
  }'

Paso 3

Polling hasta completar

GET /v1/analyses/{analysisId} hasta que status sea "completed", luego GET /v1/analyses/{analysisId}/result para la salida estructurada completa.

curl "https://alpha.inkspectra.com/_api/v1/analyses/${analysisId}" \
  -H "Authorization: Bearer fpk_test_YOUR_KEY"

Paso 4

Lee los resultados estructurados

El resultado incluye resumen, puntuación de riesgo, riesgos, obligaciones, fechas clave y evidencias, todo en JSON estructurado. El modo test devuelve datos mock deterministas.

curl "https://alpha.inkspectra.com/_api/v1/analyses/${analysisId}/result" \
  -H "Authorization: Bearer fpk_test_YOUR_KEY"

Paso 5

Guarda como contrato

POST /v1/contracts con el analysisId ana_* para persistir el análisis como contrato real (ctr_*). Usa el contractId para comparar y listar después.

curl -X POST "https://alpha.inkspectra.com/_api/v1/contracts" \
  -H "Authorization: Bearer fpk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"analysisId": "ana_..."}'

Explora la API completa

Autenticación, webhooks y sandbox cubren integración lista para producción.