/v1/sites/{pub}/subscriptionsRegistrar inscrição
Registra ou atualiza a inscrição de push de um dispositivo. O processamento é assíncrono: a API responde 202 e grava a inscrição logo depois, numa fila.
Se o endpoint já existe, a inscrição é atualizada. Quando tags vem no corpo, a lista substitui as tags atuais do assinante, e [] limpa todas. Sem o campo tags, as tags ficam como estavam. Atributos são mesclados chave a chave.
Ao enviar external_id, mande também external_id_token, assinado no seu servidor (veja o guia de identificação de usuários).
Com a organização no limite de assinantes do plano, um dispositivo novo recebe 402. Um dispositivo que já está inscrito continua sendo aceito e atualizado.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
ID público do site (pub_ seguido de 24 caracteres), o mesmo do atributo data-site do snippet.
Request body
application/jsonrequiredEndpoint de push do navegador, https, até 2048 caracteres. O host precisa ser de um serviço de push conhecido: fcm.googleapis.com, updates.push.services.mozilla.com, web.push.apple.com ou notify.windows.com.
Idioma do navegador, até 10 caracteres.
ID do usuário no seu sistema, até 255 caracteres.
HMAC-SHA256 em hexadecimal de external_id com o segredo de identidade do site. Obrigatório na prática sempre que external_id vier.
Até 50 tags. Substituem as tags atuais do assinante; [] limpa todas. Omita o campo para não mexer nas tags.
Até 50 pares chave e valor. Chaves de até 255 caracteres.
Responses
Inscrição aceita para processamento.
{
"status": "accepted"
}Values: "accepted" · "ok"
A organização atingiu o limite de assinantes do plano e o dispositivo ainda não está inscrito.
{
"message": "Limite de assinantes do plano atingido."
}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.
O cabeçalho Origin está ausente ou não consta nas origens permitidas do site.
{
"message": "Origem não permitida."
}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.
Nenhum site com esse ID público.
{
"message": "Recurso não encontrado."
}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.
Dados inválidos, ou external_id sem assinatura válida.
{
"message": "O external_id não tem uma assinatura válida do publisher."
}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.
Limite de requisições excedido. Espere os segundos indicados em Retry-After.
{
"message": "Muitas requisições. Tente novamente em instantes."
}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.
Powered by heyo