API - HGFPAY Documentação HGFPAY 2.0.
Métodos para utilização dos ERPs na integração com os serviços de REQUEST/RESPONSE.
https://api.hgfpay.com.br/v1/service/req/{cnpj}
GET para capturar as requisições salvas na base de dados em ordem crescente de acordo com o usuário com login ativo na API. É necessário passar o parâmetro CNPJ {Identificador do Posto}.
O retorno da requisição será na seguinte estrutura:
- request_id: Identificador da solicitação. Necessário para realizar o método v1/service/resp/{request_id}.
- req: Estrutura com os dados separador por | contendo as informações que são necessárias para o retorno dos dados.
- METHOD: Identificador do método a ser utilizado.
- FILTER: Filtro a ser utilizado para o método.
- VAL_FILTER: Valor do filtro.
- CNPJ: CNPJ do posto.
- SERIAL_NUMBER: Número serial do POS que está realizando a requisição.
- optional: Valor para algum parâmetro adicional que exista na requisição.
- date_added: Data que a requisição foi realizada por ordem crescente.
{
"success": "true",
"message": "Informações do Request!",
"data": [
{
"request_id": "{request_id}",
"req": "METHOD|FILTER|VAL_FILTER|CNPJ|SERIAL_NUMBER",
"optional": null,
"date_added": "2019-12-12 15:15:18",
},
{
"request_id": "{request_id}",
"req": "METHOD|FILTER|VAL_FILTER|CNPJ|SERIAL_NUMBER",
"optional": null,
"date_added": "2019-12-11 15:15:18",
}
]
}
https://api.hgfpay.com.br/v1/service/resp/{request_id}
PUT para enviar a resp de resposta para uma das requisições recuperadas no método GET v1/service/req.
Além do parâmetro request_id na URL, é necessário passar o BODY no formato
JSON com os parâmetros de acordo com cadamétodo.
O BODY da requisição será na seguinte estrutura:
- resp: Os parâmetros devem ser passados dentro do parâmetro resp.
{
"resp": [{}]
}