VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/API 4.0 (app móvel)

Avisos

Rota de avisos do app, mantida por compatibilidade, que sempre devolve uma lista vazia.

O app antigo consulta os avisos do cliente ao abrir (um sino com novidades). A plataforma mantém a rota para que esse app não falhe, mas ainda não gera avisos por aqui: a resposta é sempre a mesma, vazia. Use-a apenas para evitar um erro no app; não conte com ela para avisar o cliente.

A rota exige a ekey do cliente. O id no caminho é ignorado: o aviso nunca depende de quem o caminho cita, e o servidor não busca nada pelo id.

GET/api/4.0/CpNotifications/{userId}Cliente

Avisos do app (sempre vazio)

Devolve {"notifications":{}}.

Parâmetros de caminho

userIdstringobrigatório
Qualquer valor. Ignorado, mas precisa existir no caminho.

Exemplo de requisição

bash
curl "$BASE_URL/api/4.0/CpNotifications/1" \
  -H "Authorization: Basic $(printf '%s' "$CUSTOMER_TOKEN" | base64 -w0):"

Resposta

200Sem avisos
json
{ "notifications": {} }

Campos da resposta

notificationsobject
Sempre um objeto vazio.

Erros

StatusQuandoCorpo
401Sem ekey, vencida, ou token que não é de cliente{"error":"unauthorized"}
Não espere conteúdo

Quem precisa de uma central de avisos não deve depender desta rota. Ela existe só para o app antigo continuar abrindo sem erro.

Veja também

  • Visão geral da API 4.0
  • Cancelamento e contestação
Anterior
Cancelamento e contestação
Próxima
API de apps (token vat_)
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também