rest api routes

Home| Sprints | Histórias de Usuário|Documentos|How-to|Equipe |---|---|---|---|---|---|---|---|

Descrição

O projeto Ideias contém uma API REST como backend para manipulação de dados, permitindo assim vários clients diferentes (app, site, ou qualquer outro serviço que deseje consumir nossos dados).

A API consome JSON e produz JSON.

Para testar a API usamos(e recomendamos) a extensão Postman do Google Chrome, juntamente com a extensão Interceptor (para ser possível armazenar o JSESSIONID no Postman).

URL base para chamadas no ambiente de homologação:

http://www.homo.ages.pucrs.br/projetos/ideias/api/

Login

Realizar o login no sistema.

URL
- http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/login
Método HTTP:
- POST
Parâmetros de URL

Nenhum.
Parâmetros de dados
- Obrigatórios:
  - cpf=[String]
  - password=[String]
- Opcionais:
```
 Nenhum.
```
Resposta de sucesso:
- Código HTTP: 200
  Conteúdo: { success : true, message: "Logado" }
Resposta de erro:
- Código HTTP: 200
  Conteúdo: { success:false, message: "Usuário/senha inválidos." }

Código HTTP: 500 Internal Server Error
Conteúdo: Exceção de erro

Chamada simples:

  $.ajax({
    url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/login",
    dataType: "json",
    data:{
       cpf:"77288546586",
       password:"Sua senha"
    },
    type : "POST",
    success : function(r) {
       if(r.success){
          //Faça alguma coisa em caso de sucesso
       }else{
          //Faça alguma coisa em caso de erro
       }
    }
  });

Logout

Deslogar do sistema.

URL
- http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/logout
Método HTTP:
- GET
Parâmetros de URL

Nenhum.
Parâmetros de dados
- Obrigatórios:
  
  Nenhum.
- Opcionais:
  
  Nenhum.
Resposta de sucesso:
- Código HTTP: 200
  Conteúdo: { success : true, message: "Deslogado" }
Resposta de erro:

Nenhum.

Código HTTP: 500 Internal Server Error
Conteúdo: Exceção de erro

Chamada simples:

  $.ajax({
    url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/logout",
    dataType: "json",
    type : "GET",
    success : function(r) {
       if(r.user.cpf !== null && r.user.cpf !== ""){
          //Faça alguma coisa em caso de sucesso
       }else{
          //Faça alguma coisa em caso de erro
       }
    }
  });

Me

Busca usuário que está logado na sessão.

URL
- http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/me
Método HTTP:
- GET
Parâmetros de URL

Nenhum.
Parâmetros de dados
- Obrigatórios:
  
  Nenhum.
- Opcionais:
  
  Nenhum.
Resposta de sucesso:
- Código HTTP: 200
  Conteúdo: { user: { id: int, name: string, cpf: string, email: string, phone: string, role: string, active: boolean } }
Resposta de erro:
- Código HTTP: 200
  Conteúdo: { user: { id: null, name: null, cpf: null, email: null, phone: null, role: null, active: null} }

Código HTTP: 500 Internal Server Error
Conteúdo: Exceção de erro

Chamada simples:

  $.ajax({
    url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/logout",
    dataType: "json",
    type : "GET",
    success : function(r) {
       if(r.success){
          //Faça alguma coisa em caso de sucesso
       }else{
          //Faça alguma coisa em caso de erro
       }
    }
  });

Cadastrar Idealizador

Cadastra um novo idealizador.

URL
- http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/idealizer/register
Método HTTP:
- POST
Parâmetros de URL

Nenhum.
Parâmetros de dados
- Obrigatórios:
  - cpf=[String]
  - email=[String]
  - name=[String]
  - password=[String]
- Opcionais:
  - phone=[String]
Resposta de sucesso:
- Código HTTP: 200
  Conteúdo: { success : true, message: "Usuário cadastrado com sucesso!" }
Resposta de erro:
- Código HTTP: 200
  Conteúdo: { success:false, message: *mensagem de erro* }

Código HTTP: 500 Internal Server Error
Conteúdo: Exceção de erro

Chamada simples:

  $.ajax({
    url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/idealizer/register",
    dataType: "json",
    data:{
       cpf:"77288546586",
       email: "[email protected]",
       name:"Seu nome",
       phone: "51980778798",
       password:"Sua senha"
    },
    type : "POST",
    success : function(r) {
       if(r.success){
          //Faça alguma coisa em caso de sucesso
       }else{
          //Faça alguma coisa em caso de erro
       }
    }
  });

Cadastrar Analista

Cadastra um novo analista.

URL
- http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/analyst/register
Método HTTP:
- POST
Parâmetros de URL

Nenhum.
Parâmetros de dados
- Obrigatórios:
  - cpf=[String]
  - email=[String]
  - name=[String]
  - password=[String]
- Opcionais:
  - phone=[String]
Resposta de sucesso:
- Código HTTP: 200
  Conteúdo: { success : true, message: "Usuário cadastrado com sucesso!" }
Resposta de erro:
- Código HTTP: 200
  Conteúdo: { success:false, message: *mensagem de erro* }

Código HTTP: 500 Internal Server Error
Conteúdo: Exceção de erro

Chamada simples:

  $.ajax({
    url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/analyst/register",
    dataType: "json",
    data:{
       cpf:"77288546586",
       email: "[email protected]",
       name:"Seu nome",
       phone: "51980778798",
       password:"Sua senha"
    },
    type : "POST",
    success : function(r) {
       if(r.success){
          //Faça alguma coisa em caso de sucesso
       }else{
          //Faça alguma coisa em caso de erro
       }
    }
  });