Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolocal/arg/argapi002qr.p



Objetivo


O objetivo desta API é gerar um arquivo de imagem contendo o QR Code referente à uma nota fiscal.

A API também retorna o valor da imagem em base 64.


Funcionamento


A API pode ser executada de modo estático ou persistente. Em ambos os casos os parâmetros são os mesmos.


Versão 2 o que mudou:

1) passagem de parâmetros: recebe arg-relac-ems ao invés de nota-fiscal, devolve também um texto em base64 com o conteúdo da imagem. 

2) nome da procedure para execução persistente: agora é createQrCodeDocument.


Exemplo de execução estática:

RUN local/arg/argapi002qr.p (INPUT ROWID(arg-relac-ems), INPUT "C:\tmp\qrcode", OUTPUT c-arq-qrcode, OUTPUT c-qrcode-base64, OUTPUT TABLE RowErrors).


Exemplo execução persistente:

RUN local/arg/argapi002qr.p PERSISTENT SET h-qrcode (INPUT ?, INPUT "", OUTPUT c-arq-qrcode, OUTPUT c-qrcode-base64, OUTPUT TABLE rowErrors).


Na execução persistente deverá ser executada a procedure createJSonComprovante para retornar o qrcode:

RUN createQrCodeDocument IN h-qrcode (INPUT ROWID(arg-relac-ems), INPUT "C:\tmp\qrcode", OUTPUT c-arq-qrcode, OUTPUT c-qrcode-base64, OUTPUT TABLE RowErrors).



Parâmetros TipoConteúdo
entrada rowidrowid da tabela arg-relac-ems
entradacharacterdiretório para geração do qrcode
saídacharacterarquivo de qrcode gerado
saídalongcharimagem do qrCode em base64
saída temp-tabletemp-table RowErrors.


Caso o processamento tenha sido executado corretamente, o programa retornára "OK" e o nome do arquivo gerado será retornado no parâmetro de saída, bem como o qrcode gerado em base64.

Caso tenha ocorrido algum erro, o programa retornará "NOK" e o erro será gerado e retornado na temp-table RowErrors.