|
|
# 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**
|
|
|
----
|
... | ... | @@ -6,7 +17,7 @@ |
|
|
|
|
|
* **URL**
|
|
|
|
|
|
* localhost:8080/api/auth/login
|
|
|
* http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/login
|
|
|
|
|
|
* **Método HTTP:**
|
|
|
|
... | ... | @@ -47,7 +58,7 @@ OU |
|
|
|
|
|
```javascript
|
|
|
$.ajax({
|
|
|
url: " localhost:8080/api/auth/login",
|
|
|
url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/login",
|
|
|
dataType: "json",
|
|
|
data:{
|
|
|
cpf:"77288546586",
|
... | ... | @@ -64,7 +75,7 @@ OU |
|
|
});
|
|
|
```
|
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
**Logout**
|
|
|
----
|
... | ... | @@ -72,7 +83,7 @@ OU |
|
|
|
|
|
* **URL**
|
|
|
|
|
|
* localhost:8080/api/auth/logout
|
|
|
* http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/logout
|
|
|
|
|
|
* **Método HTTP:**
|
|
|
|
... | ... | @@ -110,7 +121,7 @@ OU |
|
|
|
|
|
```javascript
|
|
|
$.ajax({
|
|
|
url: " localhost:8080/api/auth/logout",
|
|
|
url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/auth/logout",
|
|
|
dataType: "json",
|
|
|
type : "GET",
|
|
|
success : function(r) {
|
... | ... | @@ -123,6 +134,7 @@ OU |
|
|
});
|
|
|
```
|
|
|
|
|
|
***
|
|
|
|
|
|
**Cadastrar Idealizador**
|
|
|
----
|
... | ... | @@ -130,7 +142,7 @@ OU |
|
|
|
|
|
* **URL**
|
|
|
|
|
|
* localhost:8080/api/accounts/idealizer/register
|
|
|
* http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/idealizer/register
|
|
|
|
|
|
* **Método HTTP:**
|
|
|
|
... | ... | @@ -177,7 +189,7 @@ OU |
|
|
|
|
|
```javascript
|
|
|
$.ajax({
|
|
|
url: " localhost:8080/api/accounts/idealizer/register",
|
|
|
url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/idealizer/register",
|
|
|
dataType: "json",
|
|
|
data:{
|
|
|
cpf:"77288546586",
|
... | ... | @@ -198,7 +210,7 @@ OU |
|
|
});
|
|
|
```
|
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
**Cadastrar Analista**
|
|
|
----
|
... | ... | @@ -206,7 +218,7 @@ OU |
|
|
|
|
|
* **URL**
|
|
|
|
|
|
* localhost:8080/api/accounts/analyst/register
|
|
|
* http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/analyst/register
|
|
|
|
|
|
* **Método HTTP:**
|
|
|
|
... | ... | @@ -253,7 +265,7 @@ OU |
|
|
|
|
|
```javascript
|
|
|
$.ajax({
|
|
|
url: " localhost:8080/api/accounts/analyst/register",
|
|
|
url: " http://www.homo.ages.pucrs.br/projetos/ideias/api/accounts/analyst/register",
|
|
|
dataType: "json",
|
|
|
data:{
|
|
|
cpf:"77288546586",
|
... | ... | |