Mudanças

Ir para: navegação, pesquisa

Manuais:ERP.Net/API

1 851 bytes adicionados, 14h07min de 17 de fevereiro de 2022
Adicionado __NOTITLE__
__NOTITLE__
__FORCETOC__
* Desenvolver em linguagem de programação que permita acesso à WebAPI;
* Estar familiarizado com a comunicação utilizando métodos [https://pt.wikipedia.org/wiki/REST REST API];
* Estar familiarizado com a autenticação via COOKIE;
* Conhecer a sintaxe [https://pt.wikipedia.org/wiki/JSON JSON], pois todo o envio de dados e retorno é feito utilizando-se [https://pt.wikipedia.org/wiki/JSON JSON]
'''Exemplo'''
<div class="center"><table style="border: 1px solid black;border-collapse: collapse;width: 800px;">
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td>
<td style="text-align: left;border: 1px solid black;">Endereço completo do endpoint</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Método</td>
<td style="text-align: left;border: 1px solid black;">Definição do método que deverá ser utilizado:
:GET
:POST
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Body<br/>(JSON)Tipo de Requsição*</td> <td style="text-align: left;border: 1px solid black;"><pre>
{
JSON válido para realizar a requisição. Cada endpoint requer um json diferente para ser consumido.
}
</pre>ou  QueryString pelo endpoint da requisção no formato ''&Nome=Valor''</td>
</tr>
<tr style="border: 1px solid black;">
<td style="text-align: center;padding: 7px;border: 1px solid black;">Retorno<br/>(Tipo de Retorno**)</td> <td style="text-align: left;border: 1px solid black;"><pre>{
"Data": "Pode possuir algum resultado em JSON",
"Message": "",
</tr>
</table>
</div>
* 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
* 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. <div class="center"><table style="border: 1px solid black;border-collapse: collapse;width: 800px;"><tr style="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/> 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.</td></tr></table></div> 
==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 [https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 401 (Unauthorized)]
 
===[[Manuais:ERP.Net/API/Auth|Autenticando na API]]===
 
Descreve como deverá ser realizado o login na API.
 
===[[Manuais:ERP.Net/API/EBoleto|EBoleto]]===
1 153
edições

Menu de navegação