Cómo se versiona
- La versión de la API va en la ruta: hoy es
v1, yGET /healthla informa enapi_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/methodologyrespondeversionyfingerprint. Elfingerprintcambia 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
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.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.- Rol
viewery claves de organización conscopesyread_only. Lo que no se puede hacer responde403conerror: "read_only"oerror: "key_scope". - Cambio de contrato:
enterprisedeja de ser ilimitado. Su cupo mensual es el de la organización (por defecto, 5,000,000 créditos) yX-Credits-Limitsiempre es un número. - Tope de lecturas a las fuentes por consulta (por defecto, 4,000). Pasado el tope,
reason: "budget_exhausted".