Zum Inhalt springen

Inscreve (ou renova) este aparelho

POST/api/push/subscriptions

Auth
Token erforderlich
API-Schlüssel:
Kein API-Schlüssel möglich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Qualquer papel. Recebe o `PushSubscription.toJSON()` do navegador (`endpoint` e `keys`), mais `platform` e `standalone` (aberto pelo app instalado). Cria (201) ou renova pelo endpoint (200): o mesmo navegador inscrito de novo, mesmo em outra conta, passa a ser de quem está logado. O endpoint precisa ser de um serviço de push de navegador (Google, Mozilla, Apple, Microsoft; também `jmt17.google.com`, o do Chromium); outro dá 400. No máximo 10 aparelhos por pessoa por comunidade: o mais antigo é apagado. Até 20 chamadas por hora por pessoa por comunidade; a 21ª dá 429. O rótulo (`deviceLabel`) vem do navegador.

Header

NameTypBeschreibung
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request-Body application/json

NameTypBeschreibung
endpointPflichtstringmax 2048
keysPflichtobject
keys.p256dhPflichtstring
keys.authPflichtstring
vapidKeyIdoptionalstringO `vapidKeyId` de `GET /api/push/config` usado na inscrição.
platformoptionalios | android | macos | windows | linux | other
standaloneoptionalboolean

Antworten

StatusBeschreibung
200Aparelho já inscrito: renovado.
201Aparelho inscrito.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
409Conflito com o estado atual do recurso.
429Mais de 20 inscrições por hora da mesma pessoa nesta comunidade. O cabeçalho `Retry-After` diz em quantos segundos tentar de novo.
500Erro interno do servidor.

curl-Beispiel

curl -X POST "https://api.memberfy.net/api/push/subscriptions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"endpoint":"string","keys":{"p256dh":"string","auth":"string"}}'