Mudanças entre as edições de "Manuais:ERP.Net/API"
(→Versionamento da API) |
|||
| Linha 86: | Linha 86: | ||
<table style="border: 1px solid black;border-collapse: collapse;width: 800px;"> | <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;"> | + | <td style="text-align: center;padding: 7px;border: 1px solid black;">v1.0</td> |
<td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/(ação).<br/> | <td style="text-align: left;border: 1px solid black;">https://erpnet.online/api/v1.0/(ação).<br/> | ||
| Linha 95: | Linha 95: | ||
</table> | </table> | ||
</div> | </div> | ||
| − | |||
==Requisições da API== | ==Requisições da API== | ||
Edição das 14h36min de 5 de julho de 2019
Documentação sobre as APIs do ERP.Net
Índice
Conhecimentos necessários para a utilização das APIs do ERP.Net
A integração deverá ser realizada por uma pessoa que possua os seguintes conhecimentos:
- Desenvolver em linguagem de programação que permita acesso à WebAPI;
- Estar familiarizado com a comunicação utilizando métodos REST API;
- Estar familiarizado com a autenticação via COOKIE;
- Conhecer a sintaxe JSON, pois todo o envio de dados e retorno é feito utilizando-se JSON
Dicas
- Em todo retorno recebido da API, verifique sempre as propriedades Success e StatusCode.
- A propriedade Success sempre irá retornar true se a requisição foi aceita pelo servidor e realizada com sucesso. Caso seja false, verifique a mensagem de erro em Message ou o StatusCode.
Sobre as requisições
No início da explicação de cada requisição, são informados os parâmetros de entrada e saída de cada endpoint utilizado, bem como o método REST que deverá ser utilizado.
Exemplo
| Endpoint | Endereço completo do endpoint |
| Método | Definição do método que deverá ser utilizado:
|
| Tipo de Requsição* |
{
JSON válido para realizar a requisição. Cada endpoint requer um json diferente para ser consumido.
}
ou QueryString pelo endpoint da requisção no formato &Nome=Valor |
| Retorno (Tipo de Retorno**) |
{
"Data": "Pode possuir algum resultado em JSON",
"Message": "",
"Success": true,
"StatusCode": 200
}
|
* O Tipo de Requsição pode ser:
- Body JSON
- Deverá ser informado o JSON de acordo com a documentação do método em questão;
- QueryString
- Deverá ser informado no endpoint da API, como parâmetros da requisição, no formato &Nome=Valor.
Em alguns casos raros poderá haver a combinação de ambos os tipos de requisição.
** Os tipos de retorno podem ser:
- COOKIE
- Define que o retorno deverá ser lido nos cookies de resposta. Até o momento, é utilizado apenas para realizar login na API.
- DATA
- Indica que o retorno deverá ser lido, no formato JSON, na propriedade DATA do objeto de resposta da requisição.
Versionamento da API
As APIs do ERP.Net são controlados por versões. A versão oficial é a v1.0, sempre que for realizar alguma ação a versão deverá ser informada. Desta forma é possível manter a compatibilidade entre as aplicações que utilizam as APIs do ERP.
| v1.0 | https://erpnet.online/api/v1.0/(ação). Esta versão é a primeira versão do aplicativo. Podemos realizar alterações na aplicação, que se não forem de grande impacto não sofrerá incremento no número da versão. Caso haja alterações que possam comprometer a compatibilidade entre os aplicativos, a versão será incrementada. |
Requisições da API
Antes de realizar qualquer requisição às APIs do ERP.Net, é necessário realizar o login na API para que não seja lançado o erro 401 (Unauthorized)
Autenticando na API
Descreve como deverá ser realizado o login na API.
EBoleto
Sistema emissor de boleto eletrônico.
- Bancos homologados:
- Sicredi
