Descripción general de la API

La API pública v1 te da acceso, por código, a casi todo lo que haces en el dashboard. Úsala para integrar Proteside con tu CI/CD, SIEM, herramienta de tickets o panel de partner, y usa los webhooks para reaccionar a eventos sin tener que consultar la API constantemente.

Qué puedes automatizarCopiar enlace de la sección

• Tiendas: crear una tienda, obtener la clave del SDK y el snippet de instalación, ajustar la configuración del SDK, rotar la clave y comprobar si el SDK está instalado.
• Páginas de pago: registrar las URLs de checkout que el SDK debe proteger.
• Scripts: listar el inventario y autorizar o bloquear scripts con justificación (PCI DSS 4.0, requisito 6.4.3).
• Reglas: crear, activar, desactivar y eliminar reglas de bloqueo o de permiso por dominio, URL o hash.
• Políticas de aprobación: crear, simular y aplicar políticas que deciden sobre los scripts automáticamente.
• Alertas: listar, consultar, resolver y reabrir alertas.
• Reportes PCI DSS: generar y descargar reportes en JSON, PDF o CSV y programar el envío semanal o mensual.
• Webhooks: registrar endpoints, canales de Slack y de Microsoft Teams y disparar eventos de prueba.
• Partners: crear organizaciones hijas, actuar en ellas y seguir el consumo de cada una.

Antes de empezarCopiar enlace de la sección

La API está hecha para llamadas de servidor a servidor: las rutas autenticadas no responden a CORS, así que las llamadas hechas directamente desde el navegador se bloquean. Guarda el token en tu backend.

Inicio rápidoCopiar enlace de la sección

export PROTESIDE_TOKEN="ps_live_Ab3dEf6hIj9kLm2nOp5qRs8t_..."

curl -s "https://app.proteside.com/api/v1/stores?limit=2" \
  -H "Authorization: Bearer $PROTESIDE_TOKEN"

{
  "data": [
    {
      "id": "0c1d2e3f-1111-4222-8333-444455556666",
      "org_id": "7f3c1e2a-0b4d-4c8e-9f10-2a3b4c5d6e7f",
      "name": "Mi Tienda",
      "domain": "mitienda.com",
      "country": "BR",
      "timezone": "America/Sao_Paulo",
      "status": "active",
      "sdk_key": "pk_live_3f9c0a1b2c3d4e5f60718293a4b5c6d7",
      "safe_slug": "mitienda-ps3fa9c1",
      "emergency_contact": null,
      "created_at": "2026-09-27T10:01:00.000Z",
      "updated_at": "2026-09-27T10:01:00.000Z",
      "sdk_config": {
        "mode": "monitor",
        "payment_methods": ["pix", "card"],
        "release_channel": "stable"
      }
    }
  ],
  "next_cursor": null
}

Especificación OpenAPICopiar enlace de la sección

El contrato completo de la API está en https://app.proteside.com/api/v1/openapi.json (OpenAPI 3.1, público, sin token). Importa esa dirección en Postman, en Insomnia o en el generador de clientes de tu lenguaje. La referencia de endpoints de esta documentación se genera a partir de ella.

Próximos pasosCopiar enlace de la sección

Referencia de endpointsCopiar enlace de la sección