← Volver al índice de esquemas

PlaygroundProxyRequest

Envoltorio JSON:API de la petición del proxy del Playground. El servidor reenvía la operación descrita en `data.attributes` al endpoint `/v1` destino usando la API key del propio usuario (descifrada del lado servidor), de modo que la clave nunca llega al navegador.

Propiedades

CampoTipoDescripción
data*objectCuerpo de la respuesta. Todo el contenido cuelga de aquí, según la envoltura JSON:API.
type*stringTipo del recurso JSON:API. Siempre `playground_request`.
attributes*objectAtributos del recurso: los datos propiamente dichos, separados de su identidad.
mode*string`live` reenvía la petición real al endpoint destino y devuelve su respuesta tal cual (passthrough). `playground` ejecuta el motor de simulación con escenarios y devuelve la misma respuesta que daría el endpoint real para el escenario elegido, sin efectos colaterales (sin cuota, webhooks ni notificaciones).
method*stringMétodo HTTP de la operación destino. Uno de `GET`, `POST`, `PUT`, `PATCH` o `DELETE`.
path*stringRuta absoluta del endpoint destino, con el prefijo `/v1` (por ejemplo `/v1/beneficiaries`). Debe corresponder a una operación documentada; rutas no listadas devuelven `403 path_not_allowed`.
queryobjectParámetros de query a agregar a la URL destino. Opcional.
headersobjectCabeceras del cliente a reenviar. Solo se propaga una lista acotada (p. ej. `Idempotency-Key`, `Accept-Language`); el resto se descarta. La credencial del destino la pone el servidor — nunca se reenvía `Authorization` ni `Cookie` del cliente.
bodyobject | nullCuerpo de la petición destino para métodos distintos de `GET`. Opcional / `null` cuando no aplica.
scenarioobjectEscenario de simulación para `mode: playground` (ignorado en `mode: live`). `id` selecciona el escenario (p. ej. `valid`, `not_found`) de los que lista `GET /v1/playground/templates`.
idstringIdentificador del escenario pre-cargado.
inputsobjectEntradas que parametrizan el escenario.

Usado en operaciones

  • POST /v1/playground/proxy