Alterar perfil da loja, configuração do SDK e recebedores
Endpoint PATCH /stores/{id} da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.
Qualquer subconjunto de campos. recipients é um conjunto de substituição: a lista enviada passa a ser a lista completa de recebedores fixados.
bearerAuthAutorizaçãoBearer <token>Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.
id*stringuuidorg_id?stringSomente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.
uuidapplication/json- body
mode?string"monitor""block"calibration_seconds?integer10 <= value <= 120overlay_check_interval_ms?integer500 <= value <= 60000installation_order_policy?string"warn""silent"payment_methods?array<>sensitive_fields?array<string>|null → padrões do SDK
expected_iframe_origins?array<string>Hosts de iframe permitidos.
allowed_service_workers?array<string>Caminhos de mesma origem; [] = sem restrição
gtm_containers?array<>Contêineres GTM aprovados; [] = sem restrição
developer_mode?booleantrue pausa o SDK (a configuração retorna paused:true)
release_channel?string"stable""latest"name?stringlength <= 120country?string2 <= length <= 2timezone?stringemergency_contact?string|nullrecipients?array<>Substitui o conjunto inteiro
items <= 50Loja atualizada
application/json- response
id?stringuuidorg_id?stringuuidname?stringdomain?stringcountry?stringtimezone?stringstatus?string"active""suspended""deleted"sdk_key?stringsafe_slug?string|nullemergency_contact?string|nullcreated_at?stringdate-timeupdated_at?stringdate-timesdk_config?|nullrecipients?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" } ]}Suspender uma loja (nunca exclui dados) DELETE
Endpoint DELETE /stores/{id} da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.
Listar páginas de pagamento GET
Endpoint GET /stores/{id}/pages da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.