Saltar al contenido principal

Desarrolladores

Autenticación

Autentica con API keys por organización usando Bearer o el header X-Api-Key.

Desarrolladores

Claves API

Las claves usan prefijos fpk_test_* (modo test) o fpk_live_* (modo live). Cada clave pertenece a una organización y lleva scopes explícitos.

Desarrolladores

Autorización Bearer

Envía Authorization: Bearer <api_key> en cada solicitud, o usa el header X-Api-Key. Ambos son aceptados.

curl "https://alpha.inkspectra.com/_api/v1/usage" \
  -H "Authorization: Bearer fpk_test_YOUR_KEY"

Desarrolladores

Modos test vs live

El prefijo de la clave determina el modo en el servidor — nunca eliges el pipeline. Las claves test siempre ejecutan un motor mock determinista: sin llamadas LLM, sin facturación, sin procesamiento real. Las claves live ejecutan el pipeline real; el acceso live requiere aprobación durante la beta privada.

Desarrolladores

Scopes

Otorga solo los scopes que necesita tu integración. Un scope faltante devuelve 403 insufficient_scope.

Desarrolladores

Rotación

Crea una clave de reemplazo, despliégala y luego revoca la antigua desde la consola. La rotación atómica está planificada para una versión futura.

Desarrolladores

Recomendaciones de seguridad

Nunca expongas claves en navegadores o apps móviles. Usa proxies backend de corta duración y audita el uso de claves regularmente desde la consola.

Scopes disponibles

Referencia de scopes

Cada scope mapea a un grupo de endpoints /v1. Las claves nuevas deben usar scopes de recurso; los scopes legacy (contracts:analyze, contracts:read, contracts:compare) siguen siendo aceptados por compatibilidad.

analyses:write

Crear análisis vía POST /v1/analyses (texto, URL o PDF).

analyses:read

Listar y leer análisis: GET /v1/analyses y GET /v1/analyses/{id}.

contracts:write

Guardar un análisis completado como contrato vía POST /v1/contracts.

contracts:read

Listar y leer contratos: GET /v1/contracts y GET /v1/contracts/{id}.

comparisons:write

Comparar dos análisis o contratos vía POST /v1/comparisons.

comparisons:read

Obtener resultados de comparación vía GET /v1/comparisons/{id}.

webhooks:manage

Registrar y gestionar suscripciones de webhooks vía /v1/webhooks.

usage:read

Leer resúmenes de uso para la clave autenticada vía GET /v1/usage.

Ejecuta tu primera petición

La guía rápida cubre analyze → poll con ejemplos listos para copiar.