Lembretes - API

Este webservice JSON didático contém um sistema de cadastro de lembretes pessoais.

O sistema exige que o usuário realize o procedimento de cadastro/login para realizar as operações CRUD sobre lembretes.

O sistema de autenticação do API é por meio da troca de tokens do tipo JWT. O token deve ser enviado em cada requisição via Bearer Token. O token possui uma validade de 3 minutos.

As informações a serem enviadas no corpo da requisição podem ser do tipo application/x-www-form-urlencoded ou application/json.

Pessoa

URL de requisição:

Método Exemplo Descrição Resultado
GET GET /usuario/check Verifica se o usuário está logado e com token válido 
{
  "msg" : "Você está logado"
}
GET GET /usuario/renew Realiza processo de renovação do token JWT, se o token atual ainda for válido. Retorna o novo token e revoga o token anterior 
{
  "token" : "..."
}
GET GET /usuario/logout Realiza processo de logout, se estiver logado. Revoga o token anterior 
{
  "msg" : "Logout realizado com sucesso"
}
POST POST /usuario/signup Cadastra um novo usuáro, requer login e senha. Caso o cadastro seja bem-sucedido, retorna um token JWT de autenticação. 
{
  "token" : "..."
}
POST POST /usuario/login Realiza processo de login, requer login e senha. Caso o login seja bem-sucedido, retorna um token JWT de autenticação. 
{
  "token" : "..."
}

Lembrete

URL de requisição:

Método Exemplo Descrição Resultado
GET GET /lembrete Retorna a lista de lembretes do usuário logado. 
[
  {
    "id" : 1,
    "texto" : "A vingança nunca é plena, mata a alma e a envenena",
    "data" : "2010-10-10 10:10:10",
    "idUsuario" : 10
  },
  ...
]
GET GET /lembrete/10 Retorna o lembrete com o ID especificado, se estiver logado e pertencer a tal usuário. 
{
  "id" : 10,
  "texto" : "A vingança nunca é plena, mata a alma e a envenena",
  "data" : "2010-10-10 10:10:10",
  "idUsuario" : 10
}
POST POST /lembrete Realiza o cadastro de um novo lembrete para o usuário logado. Requer texto. O lembrete deve ter 255 caracteres ou menos. 
{
  "id" : 10,
  "texto" : "A vingança nunca é plena, mata a alma e a envenena",
  "data" : "2010-10-10 10:10:10",
  "idUsuario" : 10
}
PUT PUT /lembrete/10 Realiza a edição do lembrete especificado já cadastrado. Requer texto. O lembrete deve ter 255 caracteres ou menos. O usuário deve estar logado e possuir tal lembrete. 
{
  "id" : 10,
  "texto" : "A vingança nunca é plena, mata a alma e a envenena",
  "data" : "2010-10-10 10:10:10",
  "idUsuario" : 10
}
DELETE DELETE /lembrete/10 Remove o lembrete especificado. O usuário deve estar logado e possuir tal lembrete. 
{
  "msg" : "Lembrete removido com sucesso!"
}