Referência da API

O mapa da documentação pública da API PushMesh — por onde começar, em que ordem ler, e o que cada página responde.

Referência da API

A API pública do PushMesh vive em https://api.pushmesh.io, sob o caminho /api/v1. Tudo o que uma integração precisa está aqui: você não precisa de conta para ler esta referência inteira, e é de propósito — nós preferimos que você saiba o que vai encontrar antes de decidir.

O que distingue esta API de qualquer outra de push cabe em uma linha: além de successful (“o provedor aceitou”), ela devolve recebidos — quantos aparelhos comprovadamente receberam, com prova criptográfica vinda do próprio aparelho.

Os endereços

Onde	Endereço	Para que serve
API	`https://api.pushmesh.io`	o endereço de tudo nesta referência: o seu servidor, o SDK e qualquer cliente próprio falam aqui
Painel	`https://app.pushmesh.io`	onde nascem o aplicativo, a chave de API e as credenciais de entrega
Site	`https://pushmesh.io`	a vitrine, os preços e esta documentação
SDK React Native	`npm install @pushmesh/sdk` — npmjs.com/package/@pushmesh/sdk	registro de aparelho, recibo de entrega e in-app já resolvidos no aplicativo
Suporte	`contato@pushmesh.io`	dúvida de integração, erro que não bate com a documentação, ou combinar volume antes de subir

Nenhuma rota desta referência exige que você tenha conta para ler. Para chamar, você precisa de um aplicativo e de uma chave — os dois nascem no painel, em Aplicativos e chaves.

Se você tem 15 minutos

Leia nesta ordem. São as três páginas que levam do zero ao primeiro push com prova de entrega:

Primeiros passos — os comandos que você copia e roda.
Autenticação e erros — a chave, o envelope de erro e a tabela de códigos.
Credenciais de entrega — o que ter em mãos para o push sair de verdade.

Se você está avaliando o produto

Quatro páginas respondem as perguntas que costumam decidir a escolha:

Pergunta	Página
“vocês provam entrega mesmo, ou é o mesmo ‘enviado’ de sempre?”	Recibos de entrega
“quanto trabalho é sair do meu provedor atual?”	Migrando de outro provedor
“qual o teto de tudo, e o que acontece quando eu estouro?”	Limites
“o que vocês guardam da minha base, e por quanto tempo?”	Dados, retenção e privacidade

Todas as páginas

#	Página	O que ela responde
1	Primeiros passos	do zero ao primeiro push com recibo, pelo SDK ou direto pela API
2	Autenticação e erros	formato da chave, rotação sem queda, envelope de erro, códigos e bordas
3	Aparelhos	registrar, identificar o usuário, atualizar, consultar e exportar a base
4	Enviar push	público, conteúdo, agendamento, prioridade, idempotência e ensaio
5	Recibos de entrega	a prova de chegada, o que ela garante, e como ler o resultado de um disparo
6	Mensagens In-App	campanhas dentro do aplicativo, formatos, gatilhos e funil
7	Webhooks	ser avisado em vez de perguntar, com assinatura HMAC e reentrega
8	Migrando de outro provedor	o que é aceito tal e qual, o que muda, e o que ninguém automatiza
9	Credenciais de entrega	FCM e APNs, campo por campo, com a armadilha do ambiente da Apple
10	Aplicativos e chaves	criar aplicativo, rotacionar chave e os parâmetros públicos do Firebase
11	Limites	todos os tetos, incluindo a franquia comercial do plano gratuito
12	Cabeçalhos	tudo que a API aceita e emite, incluindo o conjunto `X-Pm-*`
13	Dados, retenção e privacidade	que dado pessoal entra, quanto tempo fica, e como atender um pedido de exclusão
14	Versionamento	o que está congelado por contrato e o que pode mudar sem aviso

Três coisas que economizam a sua primeira tarde

successful não é entrega. É a aceitação do provedor. A prova de chegada é recebidos, e ela vem do aparelho.
Nem todo 200 é o que parece. id vazio com recipients: 0 significa “ninguém alcançável”, não falha; e errors pode vir como array ou como objeto dentro do mesmo 200.
A chave pm_live_ nunca entra no aplicativo publicado. As rotas que o aparelho chama foram desenhadas sem credencial exatamente por isso.

Uma nota sobre o idioma

O texto que a própria API emite — as frases de errors e os campos explain.causa / explain.como_corrigir — sai em português, sem negociação de idioma. Os exemplos em JSON desta referência mostram essas frases exatamente como elas chegam pela rede, nos dois idiomas da documentação, para o que você lê aqui bater com o que o seu log vai guardar. Ramifique o seu código pelo código HTTP e pelos campos estruturados, nunca pela frase.

Se algo aqui não bater com a realidade

É a página que está errada, e queremos saber. Toda resposta da API traz o cabeçalho X-Pm-Request-Id: cite esse identificador em contato@pushmesh.io e encontramos a chamada exata.