GET/v1/sites/{pub}/config

Obter configuração do site

Devolve a chave pública VAPID e a configuração do widget definida no painel. O SDK chama esta rota antes de registrar o service worker. A resposta pode ficar em cache por até 5 minutos na CDN.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Parameters

Values are applied to the request and the example on the right.

pubpath · stringrequired

ID público do site (pub_ seguido de 24 caracteres), o mesmo do atributo data-site do snippet.

Responses

200application/json

Configuração do site.

{
  "site_id": "pub_8fK2mQx7Lw3nRt5Yv9Bc1Dz4",
  "vapid_public_key": "BNc3Yt9…",
  "widget": {
    "soft_ask": {
      "enabled": true,
      "title": "Quer receber as novidades?",
      "body": "Avisamos quando sair promoção. Dá para desligar quando quiser.",
      "accept_label": "Quero receber",
      "dismiss_label": "Agora não",
      "snooze_days": 7,
      "format": "card",
      "position": "bottom-right",
      "background_color": "#ffffff",
      "image_url": null,
      "corner_radius": 12,
      "styles": "default"
    },
    "prompt": {
      "trigger": "load",
      "delay_seconds": 5
    }
  },
  "migration": {
    "takeover_all": false
  }
}

site_idstringoptional

ID público do site.

vapid_public_keystringoptional

Chave pública VAPID usada em pushManager.subscribe.

widgetoptional

migrationoptional

403application/json

O cabeçalho Origin está ausente ou não consta nas origens permitidas do site.

{
  "message": "Origem não permitida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Nenhum site com esse ID público.

{
  "message": "Recurso não encontrado."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.