Portais API
API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A sigla API significa "Interface de Programação de Aplicativos".
As APIs utilizam o padrão REST e o formato JSON codificado em UTF-8 para receber e retornar os dados.
O processamento das requisições do tipo GET é feito de modo síncrono. Assim, após a requisição a uma URL os resultados são imediatamente exibidos.
O processamento das requisições do tipo POST, por sua vez, é feito de modo assíncrono. Para saber o resultado, é necessário acessar a URL que é retornada no cabeçalho Location.
O resultado contém todas as informações do recurso além dos campos status e response, detalhados na documentação de cada recurso.
APIs CIGAM
Login
Autentique o usuário
 /login Realizar login |
|
| Parameters | |
| Name | Description |
| user * required
object (body) |
Example Value | Model |
| {
email: fulano@qa.com, |
|
| Responses | |
| Name | Description |
| 200 | Login realizado com sucesso Example Value | Model |
| {
message: Login realizado com sucesso, |
|
| 400 | E-mail e/ou senha inválidos Example Value | Model |
| {
message: Email e/ou senha inválidos } |
|
 /usuarios Listar usuários cadastrados |
|
| Parameters | |
| Name | Description |
| _id
string (query) |
id_ |
| nome
string (query) |
nome |
| email
string (query) |
|
| password
string (query) |
password |
| administrador
string (query) |
Available values : true, false |
| Responses | |
| Name | Description |
| 200 | Lista de usuários Example Value | Model |
| {
quantidade: 1, usuarios: [ { nome: Fulano da Silva, email: beltrano@qa.com.br, password: teste, administrador: true, _id: 0uxuPY0cbmQhpEz1 } |
|
/usuarios/{_id} Editar usuário
/usuarios/{_id} Excluir Usuário
GEContatosInternos
| /genericos/ge/Padrao/Gravar Realizar filtro |
|
| Parameters | |
| Name | Description |
| user * required
object (body) |
Example Value | Model |
| {
"Chave": "gecontatosinternos", |
|
| Responses | |
| Name | Description |
| 200 | Registro gravado Example Value | Model |
| {
"success": true, |
|
| 404 | File or directory not found. Example Value | Model |
| {
message: 404 - File or directory not found. } |
|
Parametrização
Consulte GE - Como Fazer - Ferramenta de implantação de sites e aplicações web para detalhamento do uso da ferramenta e implantação da aplicação.
Utilização
A API após ser instalada é necessário informar a URL da aplicação ou site instalado conforme indicado em Portais - API_URL.
- Quando indicado um site somente para API a URL pode ser utilizada no seguinte formato:
- Quando for uma aplicação dentro do site a URL deve ser utilizada assim:
IMPORTANTE: Quando utilizado com protocolos de segurança (https) é necessário que a API e os portais fiquem dentro do mesmo site para não existir bloqueio devido estarem em portas distintas.
É recomendado o uso de uma ferramenta do tipo Rest Client para fazer os testes de comunicação com a API, por exemplo a extensão Advanced Rest Client do Chrome.
- Abrir a extensão no crome:
- Fazer Login via API
