Mudanças entre as edições de "Manuais:ERP.Net/API/Auth"
(Criou página com '<big>'''Realizando autenticação na API'''</big> Para utilizar o serviço de APIs do ERP.Net é necessário ter uma conta criada em nosso sistema de gestão em nuvem. o [htt...') |
(Adicionado __NOTITLE__) |
||
| (5 revisões intermediárias por um outro usuário não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
| + | __NOTITLE__ | ||
<big>'''Realizando autenticação na API'''</big> | <big>'''Realizando autenticação na API'''</big> | ||
| Linha 6: | Linha 7: | ||
==Acessando a API== | ==Acessando a API== | ||
| − | + | <div class="center"> | |
| − | <table style="border: 1px solid black;border-collapse: collapse;"> | + | <table style="border: 1px solid black;border-collapse: collapse;width: 800px;"> |
<tr style="border: 1px solid black;"> | <tr style="border: 1px solid black;"> | ||
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td> | <td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td> | ||
| − | <td style="border: 1px solid black;">https://erpnet.online/api/auth/login</td> | + | <td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/auth/login</td> |
</tr> | </tr> | ||
<tr style="border: 1px solid black;"> | <tr style="border: 1px solid black;"> | ||
<td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td> | <td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td> | ||
| − | <td style="border: 1px solid black;">POST</td> | + | <td style="text-align: left;border: 1px solid black;">POST</td> |
</tr> | </tr> | ||
<tr style="border: 1px solid black;"> | <tr style="border: 1px solid black;"> | ||
<td style="text-align: center;padding: 7px;border: 1px solid black;">Body<br/>(JSON)</td> | <td style="text-align: center;padding: 7px;border: 1px solid black;">Body<br/>(JSON)</td> | ||
| − | <td style="border: 1px solid black;"><pre> | + | <td style="text-align: left;border: 1px solid black;"><pre> |
{ | { | ||
"username": "seu e-mail de usuário", | "username": "seu e-mail de usuário", | ||
| Linha 27: | Linha 28: | ||
<tr style="border: 1px solid black;"> | <tr style="border: 1px solid black;"> | ||
<td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(COOKIE)</td> | <td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(COOKIE)</td> | ||
| − | <td style="border: 1px solid black;"><pre>{ | + | <td style="text-align: left;border: 1px solid black;"><pre>{ |
| − | "Data": | + | "Data": null, |
| − | |||
"Message": "", | "Message": "", | ||
"Success": true, | "Success": true, | ||
| Linha 35: | Linha 35: | ||
}</pre> | }</pre> | ||
| − | Neste retorno é gerado um | + | <span style="color:blue;">Neste retorno '''é gerado um ''COOKIE'' que deverá ser recuperado e ser passado entre as requisições'''. </span> |
| + | |||
| + | Veja na imagem de exemplo uma requisição realizada utilizando a ferramenta [https://www.getpostman.com Postman]</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | </div> | ||
| + | |||
| + | <center>'''<span style="color: red;">ATENÇÃO</span>'''</center> | ||
| + | Cada linguagem de programação trata o cookie de forma diferente. Atente-se para a forma como a linguagem de desenvolvimento escolhida por você trata o cookie. Pode ser no ''HEADER'' ou diretamente pela coleção ''COOKIES''<br/> | ||
| + | O cookie que é retornado no objeto de resposta deverá ser passado durante as requisições. Como ''HEADER'' ou pela coleção ''COOKIES'', dependendo da linguagem de desenvolvimento escolhida. | ||
<div class="center">[[Arquivo:Manuais_ERPNet_API_Requisicao_Login.png]]</div> | <div class="center">[[Arquivo:Manuais_ERPNet_API_Requisicao_Login.png]]</div> | ||
| − | Verifique o ''StatusCode'' da resposta. Caso não seja o código 200, houve um erro na requisição. Na maioria dos casos o erro é o 401 (Não Autorizado). Verifique junto ao suporte se sua conta já foi criada, se já estiver sido criada, peça ao seu departamento de TI para que faça a alteração do usuário para que seja permitido acesso na API do ERP.Net. Veja na imagem de exemplo | + | Verifique o ''StatusCode'' da resposta ou a propriedade '''Success''. Caso não seja o código 200 ou ''true'', houve um erro na requisição. |
| + | |||
| + | Na maioria dos casos o erro é o 401 (Não Autorizado). | ||
| + | |||
| + | Verifique junto ao suporte se sua conta já foi criada, se já estiver sido criada, peça ao seu departamento de TI para que faça a alteração do usuário para que seja permitido acesso na API do ERP.Net. | ||
| + | |||
| + | Veja na imagem de exemplo onde deverá ser alterado para permitir acesso à API. | ||
<div class="center">[[Arquivo:Manuais_ERPNet_Cadastro_Pessoa_Usuario_NivelAcesso.png]]</div> | <div class="center">[[Arquivo:Manuais_ERPNet_Cadastro_Pessoa_Usuario_NivelAcesso.png]]</div> | ||
Edição atual tal como às 13h47min de 7 de julho de 2022
Realizando autenticação na API
Para utilizar o serviço de APIs do ERP.Net é necessário ter uma conta criada em nosso sistema de gestão em nuvem. o ERP.Net.
Para criar a sua conta, entre em contato com o nosso comercial pelo e-mail [email protected]
Acessando a API
| Endpoint | https://erpnet.online/api/v1.0/auth/login |
| Método | POST |
| Body (JSON) |
{
"username": "seu e-mail de usuário",
"password": "sua senha"
}
|
| Retorno (COOKIE) |
{
"Data": null,
"Message": "",
"Success": true,
"StatusCode": 200
}
Neste retorno é gerado um COOKIE que deverá ser recuperado e ser passado entre as requisições. Veja na imagem de exemplo uma requisição realizada utilizando a ferramenta Postman |
Cada linguagem de programação trata o cookie de forma diferente. Atente-se para a forma como a linguagem de desenvolvimento escolhida por você trata o cookie. Pode ser no HEADER ou diretamente pela coleção COOKIES
O cookie que é retornado no objeto de resposta deverá ser passado durante as requisições. Como HEADER ou pela coleção COOKIES, dependendo da linguagem de desenvolvimento escolhida.
Verifique o StatusCode da resposta ou a propriedade 'Success. Caso não seja o código 200 ou true, houve um erro na requisição.
Na maioria dos casos o erro é o 401 (Não Autorizado).
Verifique junto ao suporte se sua conta já foi criada, se já estiver sido criada, peça ao seu departamento de TI para que faça a alteração do usuário para que seja permitido acesso na API do ERP.Net.
Veja na imagem de exemplo onde deverá ser alterado para permitir acesso à API.
