Desarrolladores · Public API

Construya sobre la plataforma. Cada capacidad es un endpoint.

Una sola API REST versionada en los tres módulos, Platform, Intelligence y Mission Control. Aprovisione sedes, escriba política zero-trust, consulte a Lucy, dirija incidentes, transmita eventos. En autoservicio, totalmente documentada, sin cajas negras.

Obtener una clave API → Ir a la referencia

Base URL

https://api.open-systems.com/v1

Auth

Authorization: Bearer <token>

Instalar la CLI

brew install open-ch/tap/os

Referencia

Visión general

La API de Open Systems es una API REST orientada a recursos. Usa URLs predecibles en plural, acepta y devuelve JSON, se autentica con tokens bearer y emplea verbos y códigos de estado HTTP estándar. Cada capacidad de producto que puede dirigir en el portal está disponible aquí, y nuestros propios agentes de IA y partners usan exactamente la misma API.

De un vistazo

Protocolo

solo HTTPS · TLS 1.3 · cuerpos de petición y respuesta en JSON

Base URL

https://api.open-systems.com/v1 · Región UE: https://eu.api.open-systems.com/v1

Versionado

Versionado por URI (/v1) · los cambios disruptivos llegan como nueva versión mayor

Spec

OpenAPI 3.1, legible por máquina en /v1/openapi.json

Formatos

application/json · marcas de tiempo en RFC 3339 / ISO 8601 UTC

Primeros pasos

Autenticación

Autentique cada petición con un token bearer. Use claves API de larga duración para integraciones de back-end, o el flujo OAuth 2.0 client-credentials para acceso máquina a máquina con tokens efímeros y permisos con alcance definido.

POST/oauth/tokenCanjear credenciales de cliente por un token de acceso

Request

# client-credentials grant
curl -X POST https://api.open-systems.com/v1/oauth/token \
 -d "grant_type=client_credentials" \
 -d "client_id=$OS_CLIENT_ID" \
 -d "client_secret=$OS_CLIENT_SECRET" \
 -d "scope=platform:write intelligence:read"

Response · 200

{
 "access_token": "os_at_9f3c…",
 "token_type": "Bearer",
 "expires_in": 3600,
 "scope": "platform:write intelligence:read"
}

Scopes

Platform

platform:readplatform:write

Intelligence

intelligence:readintelligence:invoke

Mission Control

mc:readmc:write

Events

events:readwebhooks:manage

Primeros pasos

Convenciones

Reglas coherentes en cada recurso: paginación por cursor, idempotencia para escrituras, límites de tasa expuestos en las cabeceras y sobres de error estándar.

Reglas

Paginación

Por cursor, ?limit=50&cursor=…; la respuesta lleva next_cursor

Idempotencia

Envíe Idempotency-Key en POST para reintentar con seguridad

Límites de tasa

X-RateLimit-Limit · X-RateLimit-Remaining · Retry-After en 429

Filtrado

Parámetros de consulta, p. ej. ?status=active&region=eu-central

Errores

Sobre JSON con error.code, error.message, request_id

API Platform · Módulo 01

Sedes

Las sedes son los bordes de su red, sucursales, centros de datos y nubes. Aprovisiónelas, configúrelas y retírelas por programación; todo lo que hacía un appliance, como objeto de API.

GET/sitesListar todas las sedes

Request

curl https://api.open-systems.com/v1/sites \
 -H "Authorization: Bearer $TOKEN"

Response · 200

{
 "data": [{
  "id": "site_DE04",
  "name": "berlin-04",
  "region": "eu-central",
  "status": "active",
  "ztna": true
 }],
 "next_cursor": null
}

POST/sitesAprovisionar una nueva sede

Parámetros del body

nameobligatorio	string
regionobligatorio	string
ztna	boolean
bandwidth_mbps	integer
ha	boolean

Request

curl -X POST …/v1/sites \
 -H "Authorization: Bearer $TOKEN" \
 -d '{ "name": "berlin-04",
    "region": "eu-central",
    "ztna": true, "ha": true }'

DELETE/sites/{id}Retirar una sede

API Platform · Módulo 01

Túneles y conectividad

Gestione overlays cifrados entre sedes, nubes y el backbone global. Los túneles son conscientes de las aplicaciones y autorreparables.

POST/tunnelsCrear un túnel cifrado

Parámetros del body

fromobligatorio	site_id
toobligatorio	site_id
protocol	ipsec \| wireguard
routing	bgp \| static

Response · 201

{
 "id": "tun_8821",
 "protocol": "wireguard",
 "state": "up",
 "mtu": 1420
}

API Platform · Módulo 01

Policies · ZTNA

Acceso zero-trust como código. Aplique política declarativa desde YAML/JSON o su pipeline de CI; Lucy valida y marca reglas ensombrecidas o en conflicto antes de que entren en servicio.

PUT/policies/{name}Crear o reemplazar una policy (idempotente)

Request

curl -X PUT …/v1/policies/zero-trust \
 -H "Authorization: Bearer $TOKEN" \
 -H "Idempotency-Key: 4f1a…" \
 --data-binary @zero-trust.json

Response · 200

{
 "name": "zero-trust",
 "revision": 2291,
 "rules": 142,
 "conflicts": 0,
 "validated_by": "lucy"
}

POST/policies/{name}/rollbackRevertir al instante a una revisión anterior

API Platform · Módulo 01

Seguridad web · SWG / CASB DLP en la roadmap

Gestione por programación la inspección inline y los controles de apps cloud para cada usuario y ubicación. Los endpoints de DLP están en la roadmap.

GET/web/categoriesListar categorías de URL / de app

POST/dlp/rulesCrear una regla de prevención de pérdida de datos

Parámetros del body

classifierobligatorio	pattern \| fingerprint \| ml
action	log \| block \| quarantine
channels	array<string>

Response · 201

{
 "id": "dlp_4410",
 "classifier": "ml",
 "action": "block",
 "enabled": true
}

API Intelligence · Módulo 02

Copilot

Pregunte a la plataforma en lenguaje natural. El endpoint Copilot responde preguntas de operación y seguridad con contexto anclado en 35 años de datos operativos, y puede devolver acciones estructuradas para que usted apruebe.

POST/intelligence/copilot/queryHacer una pregunta, obtener una respuesta anclada

Request

curl -X POST …/v1/intelligence/copilot/query \
 -H "Authorization: Bearer $TOKEN" \
 -d '{ "prompt": "Why is latency high
    to site berlin-04?" }'

Response · 200

{
 "answer": "BGP flap on upstream…",
 "confidence": 0.91,
 "citations": ["evt_77…"],
 "suggested_action": {
  "type": "reroute",
  "requires_approval": true
 }
}

API Intelligence · Módulo 02

Agents

Agentes autónomos ejecutan operaciones de varios pasos dentro de límites de aprobación human-in-the-loop. Lance un run, inspeccione cada paso, apruebe las acciones bajo control.

POST/intelligence/agents/runsIniciar un run de agente

Parámetros del body

taskobligatorio	string
scope	site_id \| global
autonomy	propose \| act_with_approval

Response · 202

{
 "run_id": "run_5d2a",
 "state": "running",
 "replicates": "L3-workflow"
}

POST/intelligence/agents/runs/{id}/approveAprobar una acción bajo control (HITL)

API Intelligence · Módulo 02

Investigaciones

Investigaciones automatizadas de causa raíz, mapeadas a MITRE ATT&CK y a sus líneas base históricas.

GET/intelligence/investigations/{id}Recuperar una investigación & sus evidencias

API Mission Control · Módulo 03

Incidents

Dirija la capa respaldada por personas por programación. Cree incidentes, siga la responsabilidad de nivel 3 y lea cronologías de resolución dirigidas por expertos.

POST/mc/incidentsElevar un incidente a Mission Control

Parámetros del body

severityobligatorio	sev1 \| sev2 \| sev3
summaryobligatorio	string
site_id	string

Response · 201

{
 "id": "inc_48217",
 "severity": "sev1",
 "owner": "L3-engineer",
 "ack_eta_sec": 900
}

GET/mc/incidents/{id}/timelineCronología de resolución completa e inmutable

API Mission Control · Módulo 03

Change requests

Envíe y siga change requests atendidos por ingenieros de nivel 3, cada acción atribuible y registrada.

POST/mc/change-requestsAbrir un change request

Transversal

Events & webhooks

Suscríbase a eventos en tiempo real, estado de las sedes, cambios de policy, acciones de agentes, incidentes. Las entregas van firmadas con HMAC-SHA256 para que pueda verificar su autenticidad.

POST/webhooksRegistrar un endpoint de webhook

Request

curl -X POST …/v1/webhooks \
 -H "Authorization: Bearer $TOKEN" \
 -d '{ "url": "https://acme.com/hook",
    "events": ["incident.created",
         "agent.action.gated"] }'

Cabeceras de entrega

OS-Event: incident.created
OS-Delivery: dlv_91a2
OS-Signature: sha256=4c1f…

Transversal

Observabilidad

Transmita logs, métricas y eventos de auditoría a su propio stack. Los exportadores nativos mantienen su SIEM y su data lake sincronizados.

Destinos y formatos de export

Formatos

JSONsyslogCEFOpenTelemetry

SIEM

SplunkMicrosoft SentinelQRadar, bidireccional

Auditoría

Inmutable, a prueba de manipulaciones; cada acción de admin & agente vía GET /audit/events

Transversal

SDK & herramientas

Use el lenguaje y el workflow que ya conoce. SDK de primera clase, un provider de Terraform para infraestructura como código y una CLI de un solo binario.

Terraform

Sedes, túneles & policy declarativos.

registry.terraform.io/open-systems

SDK

Clientes idiomáticos, modelos tipados.

PythonGoTypeScriptJava

CLI

Binario único con soporte de scripts.

os sites listos policy apply

Referencia

Errores y códigos de estado

Cada error devuelve un sobre JSON coherente con un error.code estable, un mensaje legible y un request_id para soporte.

4xxSobre de errorLa misma forma para cada fallo

Ejemplo · 422

{
 "error": {
  "code": "validation_failed",
  "message": "region is required",
  "field": "region"
 },
 "request_id": "req_2f9c…"
}

Códigos comunes

200 OK

201 Created

202 Accepted

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

409 Conflict

422 Validation

429 Rate limited

Empiece a construir hoy mismo.

Consiga una clave API, instale la CLI y aprovisione su primera sede en minutos.

Obtener acceso API →Explorar la plataforma