Introdução
Aqui você irá encontrar todas as informações disponíveis para a utilização dos serviços de integração do UAU com outros sistemas.
Para utilizar a UAUApi, é necessário que tenha um conhecimento básico no consumo de serviços REST, independente da linguagem de programação.
Lembrando que, apenas os serviços homologados para integração estarão disponíveis. Caso já utilize um serviço que não está mais disponível, será necessário entrar em contato com a Globaltec acessando a área de Cliente.
Como o Desenvolvedor gera o Token de Integração
Acesse o site da Globaltec e clique no link Desenvolvedores, preencha e salve os dados, a página será redirecionada para o ambiente de integração, nesse ambiente é possível copiar o token de integração gerado, gerar um novo token e modificar os dados do desenvolvedor.
O token só será válido se uma empresa cliente da Globaltec der permissão ao desenvolvedor cadastrado. Para tal, é necessário que o gerente de projetos da empresa acesse a área de clientes para liberar a permissão ao desenvolvedor.
Como o Desenvolvedor define Versão Homologada
Acesse o site da Globaltec e realize o login utilizando usuário e senha do desenvolvedor.
- Clique no nome do Usuário e selecione o menu Desenvolvedor
- Clique em Versões Publicadas selecionando a versão e clique no botão Adicionar versão
- Após adicionar a versão o Desenvolvedor terá informado a Globaltec que sua aplicação está homologada com a versão selecionada.
Como o Gerente de Projeto da Empresa concede permissão ao Desenvolvedor
Acesse o site da Globaltec e realize o login utilizando usuário e senha do Gerente de Projeto.
- Clique no nome do Usuário e selecione o menu Desenvolvedor
- Selecione o Desenvolvedor e Ambiente [Produção/Teste] e clique em Adicionar Permissão
- Após adicionar permissão o Gerente de Projeto da Empresa concede permissão ao Desenvolvedor em determinado ambiente do UAU.
- Acesse um módulo do UAU menu Utilitários – Assistente de Atualização Automática de Dados e execute-o para que sejam atualizadas as informações dos Desenvolvedores autorizados a conectar no UAU da empresa.
O Ambiente de Testes e Swagger
A UAUApi está utilizando o Swagger para gerar a documentação interativa da API.
Para acessar essa documentação clique aqui. No Swagger estão disponíveis todos os serviços detalhados.
Juntamente com o Swagger, disponibilizamos um ambiente Sandbox onde poderá ser realizado os testes de integração
Disponibilizamos um ambiente de testes para realizar a integração com a nova API, a URI do ambiente SandBox é //snetapi.globaltec.com.br:90/UAUApi_Integracao
O formato da url completa de um serviço é:
URI + /api/v1.0/Nome_do_Serviço/Nome_do_método
Por exemplo, uma chamada do serviço que autentica um usuário ficaria:
//snetapi.globaltec.com.br:90/UAUApi_Integracao/api/v1.0/Autenticador/AutenticarUsuario
O endereço acima será utilizado apenas para Testes, antes de disponibilizar para produção altere-o para utilizar o endereço de acesso, a API do cliente.
O Postman
Outra ferramenta para auxiliar no desenvolvimento da integração é o PostMan. Todos os exemplos apresentados aqui utilizarão o Postman.
Veja na imagem abaixo como deve estar configurado o Postman para realizar as requisições.
Novamente vamos pegar como exemplo o autenticar usuário:
Observe no Header que deve ser informado o token de Integração. Para obter o token de integração deve-se realizar um cadastro na Globaltec. Para realizar esse cadastro clique aqui.
O Token
Para realizar uma chamada de sucesso nos serviços da UAUApi é necessário primeiro, realizar a autenticação do usuário. A autenticação sendo bem sucedida, será retornado um token, esse token deverá ser adicionado no HEADER de cada requisição. O tempo de expiração do token é de 2 horas.
Veja abaixo como adicionar o token na requisição utilizando o Postman:
Status HTTP de retorno
Ao realizar a requisição, o status HTTP de retorno pode ser usado para informar o resultado da requisição. Por exemplo:
200 (OK)
-Não ocorreu nenhum erro na requisição.
400 (Bad Request):
-Erro nos parâmetros da requisição;
-Informou algum parâmetro incorretamente;
401 (Unauthorized):
-Não informou o token;
-Token é inválido;
-Token expirou;
500 (Internal Server Error):
-Erro na API do UAU;
Códigos de Exemplos
-Exemplos de como montar os parâmetros da resquisição:
Os parâmetros devem ser no formato json. Segue uma lista de vários métodos com seus parâmetros preenchidos. Esse exemplo pode ser usado no ambiente Sandbox utilizando o Postman (basta colar os parâmetros no postman).
Clique aqui para visualizar a lista de métodos e parâmetros de exemplo.
-Importação dos métodos no Postman:
- Faça o download do arquivo compactado postman.zip
- No Postman clique no botão Import
- Selecione todos os arquivos descompactados
- Em seguida, serão listadas as coleções sendo possível fazer uso dos métodos.