Mudanças entre as edições de "Manuais:ERP.Net/API"
(→Documentação sobre as APIs do ERP.Net) |
|||
| Linha 3: | Linha 3: | ||
<big>'''Documentação sobre as APIs do ERP.Net'''</big> | <big>'''Documentação sobre as APIs do ERP.Net'''</big> | ||
| − | ==[[Manuais:ERP.Net/API/EBoleto|EBoleto]]== | + | ==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 [https://pt.wikipedia.org/wiki/REST REST API]; | ||
| + | * 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] | ||
| + | |||
| + | ===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 [https://pt.wikipedia.org/wiki/Endpoint endpoint] utilizado, bem como o método REST que deverá ser utilizado. | ||
| + | |||
| + | '''Exemplo''' | ||
| + | |||
| + | <table style="border: 1px solid black;border-collapse: collapse;"> | ||
| + | <tr style="border: 1px solid black;"> | ||
| + | <td style="text-align: center;padding: 7px;border: 1px solid black;">Endpoint</td> | ||
| + | <td style="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="border: 1px solid black;">Definição do método que deverá ser utilizado: | ||
| + | :GET | ||
| + | :POST | ||
| + | :PUT | ||
| + | :DELETE</td> | ||
| + | </tr> | ||
| + | <tr style="border: 1px solid black;"> | ||
| + | <td style="text-align: center;padding: 7px;border: 1px solid black;">Body<br/>(JSON)</td> | ||
| + | <td style="border: 1px solid black;"><pre> | ||
| + | { | ||
| + | JSON válido para realizar a requisição. Cada endpoint requer um json diferente para ser consumido. | ||
| + | } | ||
| + | </pre></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="border: 1px solid black;"><pre>{ | ||
| + | "Data": "Pode possuir algum resultado em JSON", | ||
| + | "Message": "", | ||
| + | "Success": true, | ||
| + | "StatusCode": 200 | ||
| + | }</pre> | ||
| + | </tr> | ||
| + | </table> | ||
| + | |||
| + | 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. | ||
| + | |||
| + | ==Requisições da API== | ||
| + | ===[[Manuais:ERP.Net/API/EBoleto|EBoleto]]=== | ||
Sistema emissor de boleto eletrônico. | Sistema emissor de boleto eletrônico. | ||
:Bancos homologados: | :Bancos homologados: | ||
::* Sicredi | ::* Sicredi | ||
Edição das 17h36min de 15 de maio de 2018
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;
- 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:
|
| Body (JSON) |
{
JSON válido para realizar a requisição. Cada endpoint requer um json diferente para ser consumido.
}
|
| Retorno (Tipo de Retorno) |
{
"Data": "Pode possuir algum resultado em JSON",
"Message": "",
"Success": true,
"StatusCode": 200
}
|
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.
Requisições da API
EBoleto
Sistema emissor de boleto eletrônico.
- Bancos homologados:
- Sicredi
