Proteside Docs
Referencia de endpointsTiendas

Modificar el perfil de la tienda, la configuración del SDK y los destinatarios

PATCH
/stores/{id}

Cualquier subconjunto de campos. recipients es un conjunto de reemplazo: la lista enviada pasa a ser la lista completa de destinatarios fijados.

Autorización

bearerAuth
headerAutorizaciónBearer <token>

Token de API creado en Ajustes → API. Los alcances están vinculados al token; cada operación indica el alcance requerido en x-scope.

Parámetros de ruta

id*string
Formatouuid

Parámetros de consulta

org_id?string

Solo socios (orgs:manage): actúa sobre esta organización hija. También se puede enviar como org_id en cuerpos JSON.

Formatouuid

Cuerpo de la solicitud

application/json
  1. body
mode?string
Valor en"monitor""block"
calibration_seconds?integer
Rango10 <= value <= 120
overlay_check_interval_ms?integer
Rango500 <= value <= 60000
installation_order_policy?string
Valor en"warn""silent"
payment_methods?array<>
sensitive_fields?array<string>|

null → SDK defaults

expected_iframe_origins?array<string>

Hosts (suffix match) of expected payment iframes, e.g. js.stripe.com

allowed_service_workers?array<string>

Same-origin paths; [] = no restriction

gtm_containers?array<>

Approved GTM containers; [] = no restriction

developer_mode?boolean

true pauses the SDK (config returns paused:true)

release_channel?string
Valor en"stable""latest"
name?string
Longitudlength <= 120
country?string
Longitud2 <= length <= 2
timezone?string
emergency_contact?string|null
recipients?array<>

Replace-set

Elementositems <= 50

Cuerpo de la respuesta

Tienda actualizada

application/json
  1. response
id?string
Formatouuid
org_id?string
Formatouuid
name?string
domain?string
country?string
timezone?string
status?string
Valor en"active""suspended""deleted"
sdk_key?string
safe_slug?string|null
emergency_contact?string|null
created_at?string
Formatodate-time
updated_at?string
Formatodate-time
sdk_config?|null
recipients?array<>
curl -X PATCH "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "mode": "block",    "gtm_containers": [      "GTM-ABC1234"    ],    "recipients": [      {        "method": "pix",        "key": "financeiro@lojadojoao.com.br"      }    ]  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "name": "string",  "domain": "string",  "country": "string",  "timezone": "string",  "status": "active",  "sdk_key": "string",  "safe_slug": "string",  "emergency_contact": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "sdk_config": {    "mode": "monitor",    "calibration_seconds": 0,    "overlay_check_interval_ms": 0,    "installation_order_policy": "warn",    "payment_methods": [      "pix"    ],    "sensitive_fields": [      "string"    ],    "expected_iframe_origins": [      "string"    ],    "allowed_service_workers": [      "string"    ],    "gtm_containers": [      "string"    ],    "developer_mode": true,    "release_channel": "stable",    "updated_at": "2019-08-24T14:15:22Z"  },  "recipients": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "method": "pix",      "key_masked": "string",      "key_hash": "string",      "label": "string",      "active": true,      "created_at": "2019-08-24T14:15:22Z"    }  ]}