Notificações para usuários

GET /notifications/api/

  • Lista mensagens do usuário
  • Todos os parâmetros são opcionais.
  • Autenticação utilizando api_token ou email e senha do usuário.

  • As informações de paginação são incluidas no header Link de cada resposta, conforme necessário, como exemplificado abaixo:

    Link: <https://app.passaporteweb.com.br/notifications/api/?page=3&limit=1>; rel=next,
    <https://app.passaporteweb.com.br/notifications/api/?page=1&limit=1>; rel=prev,
    <https://app.passaporteweb.com.br/notifications/api/?page=3&limit=1>; rel=last,
    <https://app.passaporteweb.com.br/notifications/api/?page=1&limit=1>; rel=first
Parâmetro Descrição Default Exemplo
show_read Considerar notificações lidas false true/false
since Data inicial   '2011-11-20'
page Determina a página de resultados 1 3
limit Limita o número de notificações 20 50
ordering Critério de ordenação oldest-first oldest-first/newest-first
Código de retorno Descrição
200 OK Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação)
404 Not Found O número da página solicitada não existe
500 Internal Server Error Erro interno do Passaporte Web

POST /notifications/api/

  • Envia uma mensagem a um usuário
  • Os parâmetros target_url, scheduled_to e tags são opcionais.
  • Autenticação utilizando token e secret da aplicação, api_token ou email e senha do usuário.
Parâmetro Descrição Default Exemplo
destination UUID do destinatário da mensagem   ac3540c7-5453-424d-bdfd-8ef2d9ff78df
body Corpo da mensagem (até 140 caraceres)   Feliz ano novo!
target_url URL associada à mensagem   https://app.passaporteweb.com.br
scheduled_to Data para publicação da mensagem   2012-01-01 00:00:00
tags Tags da mensagem   ["login", "payment", "audit", "log"]
Código de retorno Descrição
201 Created Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: api_token de um usuário)
404 Not Found Não existe notificação identificável pelo UUID fornecido
500 Internal Server Error Erro interno do Passaporte Web

GET /notifications/api/count/

  • Conta mensagens do usuário
  • Todos os parâmetros são opcionais.
  • Autenticação utilizando api_token ou email e senha do usuário.
Parâmetro Descrição Default Exemplo
show_read Considerar notificações lidas false true/false
since Data inicial   '2011-11-20'
Código de retorno Descrição
200 OK Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação)
500 Internal Server Error Erro interno do Passaporte Web

PUT /notifications/api/:uuid/

  • Marca uma notificação como lida
  • Não recebe parâmetros.
  • Autenticação utilizando api_token ou email e senha do usuário.
Código de retorno Descrição
200 OK Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação)
404 Not Found Não existe notificação identificável pelo UUID fornecido
500 Internal Server Error Erro interno do Passaporte Web

DELETE /notifications/api/:uuid/

  • Exclui uma mensagem de um usuário.
  • Não recebe parâmetros.
  • Somente mensagens ainda não publicadas podem ser excluidas.
  • Autenticação utilizando token e secret da aplicação.
Código de retorno Descrição
204 No Content Operação completada com sucesso
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Esta notificação já foi publicada, portanto não pode ser excluída. Credenciais informadas são inválidas para este recurso (ex: api_token de um usuário)
404 Not Found Não existe notificação identificável pelo UUID fornecido
500 Internal Server Error Erro interno do Passaporte Web

Notificações para contas

GET /notifications/api/accounts/:account_uuid/

  • Lista mensagens de uma conta
  • Todos os parâmetros são opcionais.
  • Autenticação utilizando token e secret da aplicação

  • As informações de paginação são incluidas no header Link de cada resposta, conforme necessário, como exemplificado abaixo:

    Link: <https://app.passaporteweb.com.br/notifications/api/?page=3&limit=1>; rel=next,
    <https://app.passaporteweb.com.br/notifications/api/?page=1&limit=1>; rel=prev,
    <https://app.passaporteweb.com.br/notifications/api/?page=3&limit=1>; rel=last,
    <https://app.passaporteweb.com.br/notifications/api/?page=1&limit=1>; rel=first
Parâmetro Descrição Default Exemplo
since Data inicial   '2011-11-20'
page Determina a página de resultados 1 3
limit Limita o número de notificações 20 50
ordering Critério de ordenação oldest-first oldest-first/newest-first
Código de retorno Descrição
200 OK Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação)
404 Not Found O número da página solicitada não existe
500 Internal Server Error Erro interno do Passaporte Web

POST /notifications/api/accounts/:account_uuid/

  • Envia uma mensagem a uma conta
  • Os parâmetros target_url, scheduled_to e tags são opcionais.
  • Autenticação utilizando token e secret da aplicação
  • A notificação criada será acessível por todos os membros desta conta na aplicação que gerou a notificação
Parâmetro Descrição Default Exemplo
body Corpo da mensagem (até 140 caraceres)   Feliz ano novo!
target_url URL associada à mensagem   https://app.passaporteweb.com.br
scheduled_to Data para publicação da mensagem   2012-01-01 00:00:00
tags Tags da mensagem   ["login", "payment", "audit", "log"]
Código de retorno Descrição
201 Created Operação completada com sucesso
400 Bad Request Um ou mais parâmetros fornecidos possui valor inválido, ver corpo da resposta
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: api_token de um usuário)
404 Not Found Não existe notificação identificável pelo UUID fornecido
500 Internal Server Error Erro interno do Passaporte Web

DELETE /notifications/api/accounts/:account_uuid/:uuid/

  • Exclui uma mensagem enviada a uma conta.
  • Não recebe parâmetros.
  • Somente mensagens ainda não publicadas podem ser excluidas.
  • Autenticação utilizando token e secret da aplicação.
Código de retorno Descrição
204 No Content Operação completada com sucesso
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Esta notificação já foi publicada, portanto não pode ser excluída. Credenciais informadas são inválidas para este recurso (ex: api_token de um usuário)
404 Not Found Não existe notificação identificável pelo UUID fornecido
500 Internal Server Error Erro interno do Passaporte Web