Proteside Docs
Referência de endpointsLojas

Criar uma loja

Endpoint POST /stores da API do Proteside: parâmetros, corpo da requisição, respostas e exemplos de código.

POST
/stores

Mesmas etapas do assistente de onboarding: domínio normalizado e globalmente único (409 conflict), limite de lojas do plano (403 plan_limit), loja + configuração do SDK + recebedores (as chaves não são armazenadas em texto claro) + canal de e-mail padrão para o proprietário + páginas de pagamento. A resposta inclui a sdk_key e snippets de instalação prontos para colar.

Autorização

bearerAuth
headerAutorizaçã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.

Parâmetros de consulta

org_id?string

Somente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.

Formatouuid

Parâmetros de cabeçalho

Idempotency-Key?string

Reproduz a resposta original por 24 h

Tamanho1 <= length <= 255

Corpo da requisição

application/json
  1. body
mode?string
Valor em"monitor""block"
calibration_seconds?integer
Intervalo10 <= value <= 120
overlay_check_interval_ms?integer
Intervalo500 <= value <= 60000
installation_order_policy?string
Valor em"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?boolean

true pausa o SDK (a configuração retorna paused:true)

release_channel?string
Valor em"stable""latest"
domain*string

Nome do host; esquema/caminho são removidos

name?string
Tamanholength <= 120
country?string
Tamanho2 <= length <= 2
Padrão"BR"
timezone?string
Padrão"America/Sao_Paulo"
emergency_contact?|
Tamanholength <= 32
recipients?array<>
Itensitems <= 50
payment_pages?array<>
Itensitems <= 50

Corpo da resposta

Criada

application/json
  1. response
id?string
Formatouuid
org_id?string
Formatouuid
name?string
domain?string
country?string
timezone?string
status?string
Valor em"active""suspended""deleted"
sdk_key?string
safe_slug?string
emergency_contact?string|null
created_at?string
Formatodate-time
updated_at?string
Formatodate-time
sdk_config?|null
recipients?array<>
pages?array<>
snippets?
curl -X POST "https://example.com/stores" \  -H "Content-Type: application/json" \  -d '{    "domain": "lojadojoao.com.br",    "name": "Loja do João",    "country": "BR",    "timezone": "America/Sao_Paulo",    "payment_methods": [      "pix",      "card",      "boleto"    ],    "expected_iframe_origins": [      "js.stripe.com"    ],    "recipients": [      {        "method": "pix",        "key": "12.345.678/0001-90",        "label": "CNPJ principal"      }    ],    "payment_pages": [      {        "url_pattern": "/checkout/*",        "payment_methods": [          "pix",          "card"        ]      }    ]  }'
{  "id": "0c1d2e3f-1111-4222-8333-444455556666",  "org_id": "7f3c1e2a-0b4d-4c8e-9f10-2a3b4c5d6e7f",  "name": "Loja do João",  "domain": "lojadojoao.com.br",  "country": "BR",  "timezone": "America/Sao_Paulo",  "status": "active",  "sdk_key": "pk_live_YOUR_KEY",  "safe_slug": "lojadojoao-ps3f9a1c",  "emergency_contact": null,  "created_at": "2026-09-27T10:01:00.000Z",  "updated_at": "2026-09-27T10:01:00.000Z",  "sdk_config": {    "mode": "monitor",    "calibration_seconds": 30,    "overlay_check_interval_ms": 2000,    "installation_order_policy": "warn",    "payment_methods": [      "pix",      "card",      "boleto"    ],    "sensitive_fields": null,    "expected_iframe_origins": [      "js.stripe.com"    ],    "allowed_service_workers": [],    "gtm_containers": [],    "developer_mode": false,    "release_channel": "stable",    "updated_at": "2026-09-27T10:01:00.000Z"  },  "recipients": [    {      "id": "9a8b7c6d-2222-4333-8444-555566667777",      "method": "pix",      "key_masked": "**.345.678/****-**",      "key_hash": "7c7dac78918c6c60b979661b7a539c2b5bbfb40f8305ff276afebe7b738caa82",      "label": "CNPJ principal",      "active": true,      "created_at": "2026-09-27T10:01:00.000Z"    }  ],  "pages": [    {      "id": "5e4d3c2b-3333-4444-8555-666677778888",      "store_id": "0c1d2e3f-1111-4222-8333-444455556666",      "url_pattern": "/checkout/*",      "url": "/checkout/*",      "domain": "lojadojoao.com.br",      "is_payment_page": true,      "mode": "monitor",      "payment_methods": [        "pix",        "card"      ],      "status": "active",      "created_at": "2026-09-27T10:01:00.000Z"    }  ],  "snippets": {    "html": "<!-- Proteside Start -->\n<!-- Place first in <head>, before GTM, Stripe.js, analytics, or any other scripts. -->\n<script>\"use strict\";var __ProteBoots=(()=>{…})();</script>\n<script async src=\"https://cdn.proteside.com/v1/shield.js\"\n        data-key=\"pk_live_YOUR_KEY\"\n        data-api=\"https://app.proteside.com/api/sdk\"></script>\n<!-- Proteside End -->",    "nextjs": "…",    "nuxt": "…",    "wordpress": "…"  }}