Saltar al contenido principal

Cómo se versiona

  • La versión de la API va en la ruta: hoy es v1, y GET /health la informa en api_version.
  • Los cambios aditivos no cambian la versión: un campo nuevo en una respuesta, un parámetro opcional o un endpoint nuevo. Tu cliente tiene que ignorar los campos que no conoce.
  • Un cambio de contrato (sacar o renombrar un campo, o cambiar lo que significa) se anuncia acá con la fecha y qué hacer.
  • La metodología (las reglas con las que se afirma algo) tiene su propia versión: GET /v1/methodology responde version y fingerprint. El fingerprint cambia si cambia cualquier umbral, aunque el código no cambie.
Los paquetes de evidencia sellados registran la versión de la metodología con la que se armaron, así que un informe viejo se puede reproducir y verificar con las reglas de su momento.

Cambios recientes

Auditoría de smart contracts
Nuevos GET /v1/audit, GET /v1/audit/{id} y GET /v1/audit/{id}/{section}, sin costo. Una auditoría la ve solo su organización. Mientras el motor de auditoría no esté disponible, responden auditorías sintéticas marcadas demo: true.
Cupo enterprise
En el plan enterprise, todo lo que gasta la organización suma a su cupo y se corta al llegar, también las claves de la organización y las de miembros con otro plan. X-Credits-* y GET /v1/account muestran la cuenta con menos saldo, y credits.shared dice si es la de la organización.
Roles de solo lectura, claves de organización y topes de costo
  • Rol viewer y claves de organización con scopes y read_only. Lo que no se puede hacer responde 403 con error: "read_only" o error: "key_scope".
  • Cambio de contrato: enterprise deja de ser ilimitado. Su cupo mensual es el de la organización (por defecto, 5,000,000 créditos) y X-Credits-Limit siempre es un número.
  • Tope de lecturas a las fuentes por consulta (por defecto, 4,000). Pasado el tope, reason: "budget_exhausted".
Causa de las fallas
El 503 source_unavailable suma source_fault y failure_cause (aditivo).
Guard
Nuevos endpoints /v1/guard/* para vigilar direcciones y operar sus alertas, sin costo. Necesitan una clave asignada a una persona.