SDK · Documentación de OpenWAF

Clientes tipados de TypeScript y Python para la API de OpenWAF, generados desde su contrato OpenAPI, un solo fichero cada uno y sin dependencias.

OpenWAF tiene dos clientes oficiales de la API, generados desde el mismo contrato OpenAPI que la referencia de la API:

SDK	Fichero	Funciona en	Dependencias
TypeScript / JavaScript	`openwaf.ts`	Bun, Deno, Node.js con eliminación de tipos de TypeScript, navegadores y cualquier cadena de herramientas de TypeScript; usa `fetch`	Ninguna
Python	`openwaf.py`	Python 3.8 o posterior	Ninguna (biblioteca estándar)

Cada SDK es un único fichero que descargas de la propia API y guardas en tu proyecto. Tiene un método por cada operación de la API que puede llamar un token de API, con parámetros y respuestas tipados, y el mismo protocolo de cambios que el panel y la CLI: un motivo en cada escritura, simulación y versión esperada.

import { OpenWAF } from "./openwaf.ts";

const owf = new OpenWAF({ baseUrl: "https://dash.openwaf.dev" }); // token de OPENWAF_TOKEN
const { items = [] } = await owf.listZones();
for (const z of items) console.log(z.name, z.status, z.config_version);

from openwaf import OpenWAF

owf = OpenWAF(base_url="https://dash.openwaf.dev")  # token de OPENWAF_TOKEN
for z in owf.list_zones()["items"]:
    print(z["name"], z["status"], z["config_version"])

Primeros pasosdescarga el SDK, configura un token y lista tus zonas.Cómo se generan los SDKde dónde salen los ficheros y cómo corresponden los métodos a las operaciones de la API.Autenticación y configuracióntoken, dirección de la API y organización.Escrituras: motivo, simulación y versiónel protocolo de cambios desde código.Gestión de erroresOpenWAFError, sus códigos y los conflictos de versión.Paginaciónrecorre el historial de versiones y la auditoría.Crear un registro DNSsimula, revisa y confirma un cambio.Purgar la cachépurga URL tras un despliegue.Referencia de TypeScriptopciones del cliente, convenciones de los métodos, errores y tipos.Referencia de Pythonconstructor, convenciones de los métodos, errores y valores devueltos.