O que é a API do Loja?
A API do Loja é uma interface de integração que permite todas as operções relacionadas a um cadastro (Incluir, Alterar, Consultar, Excluir) de informações relacionadas ao ModerLoja. Um caso de uso dessa Api, é utilização para fins de integração entre sistemas, como por exemplo, nós internamente utilizamos a Api para a integração com o sistema Food.
Como instalar?
A Api Loja só pode ser instalada no servidor, e é necessário que já possua o Administrativo instalado na máquina. Para instalar basta iniciar o instalador original do sistema (LojamixWebInstaller.exe):
Selecionar a opção Nova Instalação, tipo Servidor, módulo web (Api Loja), prossiga com a instalação, acompanhando o progresso até o término, ao concluir, será informado o endereço para acessar a API.
Falando técnicamente a API roda no IIS do windows como um aplicativo:
Como utilizar?
Após ter a API instalada e rodando, é necessário obter a licença no portal do parceiro, para o produto “Api ModerLoja“, dessa forma já poderá utiliza-la. O primeiro passo é obter o Token de autenticação, usado para autorizar a consulta em todos enpoints (API utiliza autenticação Bearer Token).
OBS: Uma ferramenta que pode ser utilizada para entender e testar a API é o Postman, que permite fazer as requisições como nas imagens acima.
Exemplo para obtenção do token:
Faça uma requisição HTTP POST para o endpoint:
POST: http://localhost/ModernizaApi/token Com o corpo da requisição no formato x-www-form-urlencoded contendo:
grant_type: “password”
username: “admin”
password: “lojamixadm”
A resposta será:
{ “access_token”: “token-gerado”, “token_type”: “bearer”}
Esse token recebido vai ser utilizado para realizar a autenticação nos outros endpoints da API.
Para tem mais informações sobre os endpoints, detalhes dos campos e infomações, deve ser acessar a pagina web com a documentação técnica:
OBS: Aconselhamos a utilizar a API com muito cuidado, pois estaram alterando as informações diretamente no banco de dados.