API de Transações
Segunda-via Boleto
Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.
Estrutura
Para criar uma transação de segunda via de boleto é utilizada a estrutura, conforme Tabela 01:
Método |
PUT |
---|---|
URL |
https://api.asteroidetecnologia.com.br
|
Recurso |
/transactions/segunda-via |
Endpoint |
https://api.asteroidetecnologia.com.br/transactions/segunda-via
|
Request Body - JSON
Para criar uma transação de segunda via de boleto é preciso enviar o Request Body JSON, conforme exemplo:
(em seguida veja o que cada parâmetro significa).
{ "guid": "venda.5c3e1f4bd815b3.53778551", "dias": "10" }
Parâmetros
Parâmetro | Padrão | Descrição |
---|---|---|
guid:String |
not null | O identificador único da transação, que neste caso é guid retornado ao criar uma transação |
dias:Integer |
2 | O total de dias para o boleto vencer |
Exemplos
Veja alguns exemplos de como realizar uma requisição à API de Transações enviando o Request Body JSON para solicitar a segunda-via de uma transação de boleto.
# certifique-se de ter o comando "curl" instalado \ curl -X PUT https://api.asteroidetecnologia.com.br/transactions/segunda-via \ -H 'Content-Type: application/json' \ -H 'asteroide-key: SEU_TOKEN_AQUI' \ -H 'asteroide-pass: SUA_SENHA_AQUI' \ -d '{ "guid": "venda.5c3e1f4bd815b3.53778551", "dias": "10" }'
// certifique-se de ter a extensão php_curl instalada $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.asteroidetecnologia.com.br/transactions/segunda-via', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'asteroide-key: SEU_TOKEN_ASTEROIDE', 'asteroide-pass: SUA_SENHA_ASTEROIDE', ), CURLOPT_POSTFIELDS => json_encode(array( 'guid' => 'venda.5c3e1f4bd815b3.53778551', 'dias' => '10' )), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo 'cURL Error #:' . $err; } else { echo $response; }
// No mesmo diretório do arquivo "package.json" // npm install --save request var request = require("request"); var options = { method: 'PUT', url: 'https://api.asteroidetecnologia.com.br/transactions/segunda-via', headers: { 'Content-Type': 'application/json', 'asteroide-key': 'SEU_TOKEN_ASTEROIDE', 'asteroide-pass': 'SUA_SENHA_ASTEROIDE' }, json: true body : { guid: "venda.5c3e1f4bd815b3.53778551", dias: "10" } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Retorno JSON
No caso de sucesso você deverá ver algo como:
(perceba que o guid
retornado não é mais o enviado)
Importante
Perceba que o guid
retornado não é mais o enviado. Isto quer dizer que uma nova transação foi criada. Neste caso a transação antiga continua armazenada, mas voce deve utilizar a segunda-via gerada.
{ "http_status": 200, "body": { "data_vencimento": "2019-01-25", "url_boleto": "https://api.asteroidetecnologia.com.br/b/venda.5c3e28793704c7.72902560", "numero_boleto": 10, "linha_digitavel": "34191.09008 00001.070051 72219.540001 1 77800000010000", "tipo": "boleto", "guid": "venda.5c3e28793704c7.72902560" } }