docs.vario.lat

GET /api/v1/playbooks

Devuelve la lista de playbooks disponibles: las combinaciones de conduct_type y language que el endpoint de análisis acepta como valores válidos.


Autenticación

Requiere API key con el scope playbooks:list.

Authorization: Bearer vario_TU_API_KEY

Parámetros

Este endpoint no acepta body ni query parameters.


Response

HTTP 200 — éxito

{
  "playbooks": [PlaybookEntry]
}

Estructura del response

CampoTipoDescripción
playbooksarrayLista de objetos PlaybookEntry. Puede crecer en versiones futuras.

PlaybookEntry

CampoTipoDescripción
conduct_typestringIdentificador de la conducta. Usar este valor en el campo playbook de POST /analyze.
languagesarray[string]Códigos ISO 639-1 de los idiomas soportados para este playbook.
descriptionstringDescripción breve de la conducta.
versionstringVersión del playbook.

Conductas disponibles

conduct_typeConductaIdiomas
price_fixingCoordinación de precioses, en
bid_riggingManipulación de licitacioneses, en
briberySoborno y anticorrupciónes, en
market_manipulationAbuso de mercadoes, en
information_exchangeIntercambio de informaciónes, en
group_boycottBoicot colectivoes, en
conflict_of_interestConflictos de interés no declarados y autocontrataciónes, en
insider_tradingUso de información privilegiada y tippinges, en
internal_fraudFraude interno, malversación y fraude de gastoses, en

Cuándo llamar a este endpoint

  • Al inicializar la integración: obtén los valores válidos de conduct_type antes de construir cualquier request a POST /analyze. Enviar un playbook no reconocido devuelve 400 INVALID_PLAYBOOK.
  • Para detectar playbooks nuevos: vario incorporará nuevas conductas en versiones futuras. Llama a este endpoint de forma dinámica en lugar de hardcodear los valores, para que tu integración los soporte automáticamente.

Ejemplo completo

Request:

curl https://api.vario.lat/v1/playbooks \
  -H "Authorization: Bearer vario_TU_API_KEY"

Response:

{
  "playbooks": [
    {
      "conduct_type": "price_fixing",
      "languages": ["es", "en"],
      "description": "Coordinación de precios entre competidores",
      "version": "1.0"
    },
    {
      "conduct_type": "bid_rigging",
      "languages": ["es", "en"],
      "description": "Manipulación de licitaciones y procesos de compra",
      "version": "1.0"
    },
    {
      "conduct_type": "bribery",
      "languages": ["es", "en"],
      "description": "Soborno y conductas contrarias a normas anticorrupción",
      "version": "1.0"
    },
    {
      "conduct_type": "market_manipulation",
      "languages": ["es", "en"],
      "description": "Abuso de mercado",
      "version": "1.0"
    },
    {
      "conduct_type": "information_exchange",
      "languages": ["es", "en"],
      "description": "Intercambio de información comercialmente sensible entre competidores",
      "version": "1.0"
    },
    {
      "conduct_type": "group_boycott",
      "languages": ["es", "en"],
      "description": "Boicot colectivo y prácticas de exclusión concertada",
      "version": "1.0"
    },
    {
      "conduct_type": "conflict_of_interest",
      "languages": ["es", "en"],
      "description": "Conflictos de interés no declarados y autocontratación",
      "version": "1.0.0"
    },
    {
      "conduct_type": "insider_trading",
      "languages": ["es", "en"],
      "description": "Uso de información privilegiada y tipping",
      "version": "1.0.0"
    },
    {
      "conduct_type": "internal_fraud",
      "languages": ["es", "en"],
      "description": "Fraude interno, malversación y fraude de gastos",
      "version": "1.0.0"
    }
  ]
}

Errores posibles

HTTPCódigoDescripción
401MISSING_AUTHHeader Authorization ausente.
401INVALID_API_KEYAPI key no encontrada, expirada o inactiva.
402SUBSCRIPTION_REQUIREDEl tenant no tiene suscripción activa.
403INSUFFICIENT_SCOPELa API key no tiene el scope playbooks:list.
429RATE_LIMIT_EXCEEDEDRate limit alcanzado. Consulta el header Retry-After.

Nota sobre versiones futuras

vario añadirá nuevos playbooks y nuevos idiomas en versiones futuras. Se recomienda llamar a GET /playbooks de forma dinámica al iniciar cada sesión de integración en lugar de hardcodear la lista de conductas. Los valores de conduct_type son estables una vez publicados — no se renombran entre versiones menores.

El output de la API es una señal de riesgo, no una determinación legal. No sustituye la revisión por un abogado ni constituye por sí solo evidencia ante reguladores.