Olá, tudo bom? Aqui vamos explicar como você irá usar nosso componente de converter HTML para PDF. Para você que já implementou uma API REST acesse os endereços e leia a documentação:

• https://api.htmlparapdf.com.br/swagger/index.html
• https://api.htmlparapdf.com.br/swagger/v1/swagger.json

Para você que nunca integrou uma API REST, continue lendo os tópicos seguintes que você vai conseguir utilizar as funcionalidades facilmente.

Para você desenvolvedor que deseja escrever uma API REST é fundamental documentar sua API, com base nesta premissa desenvolvemos a nossa utilizando SWAGGER. O Swagger é uma ferramenta que permite criar documentação para APIs e distribuir a documentação de forma otimizada, organizada, automatizada de fácil entendimento. Você pode acessar nosso swagger pelos endereços:

• https://api.htmlparapdf.com.br/swagger/index.html

O Postman é uma ferramenta que tem como objetivo testar serviços REST (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno.

Leia a licença de uso da ferramenta no site do fabricante e faça o download do Postman pelo link:

• https://www.postman.com/downloads/

Com o POSTMAN é possível realizar as requisições conforme as especificações da API, sem termos implementado ao menos uma linha de código, desta forma, auxiliando nos testes de API’s, e para que possamos também realizar testes em nossas API’s para verificar se o comportamento dela está dentro do esperado.

Para utlizar o POSTMAN é muito simples, basta você importar o link json da documentação da nossa API dentro do POSTMAN e os métodos já ficam visiveis dentro da ferramenta, veja link e exemplo na animação abaixo:

• https://api.htmlparapdf.com.br/swagger/v1/swagger.json

A grande vantagem desta ferramenta é a exportação de código fontes na integração da API para várias linguagens de programação. A imagem a seguir demostra como é fácil exportar códigos fontes:

O exemplo de códigos abaixo foram extraidos via POSTMAN, para exportar o código fonte você deverá seguir o recomendado no tópico anterior. Nos próximos tópicos vamos disponibilizar alguns exemplos nas platatormas JavaScript, PHP e C#.

O exemplo de códigos abaixo foram extraidos via POSTMAN: <script> // Code DEMO here var settings = { "url": "//v1/Consultar?user=<string>&key=<string>&ArquivoID=<string>", "method": "GET", "timeout": 0, }; $.ajax(settings).done(function (response) { console.log(response); }); </script>

O exemplo de códigos abaixo foram extraidos via POSTMAN: <?php require_once 'HTTP/Request2.php'; $request = new HTTP_Request2(); $request->setUrl('//v1/Consultar?user=<string>&key=<string>&ArquivoID=<string>'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ?>

O exemplo de códigos abaixo foram extraidos via POSTMAN: using System; using RestSharp; namespace HelloWorldApplication { class HelloWorld { static void Main(string[] args) { var client = new RestClient("//v1/Consultar?user=<string>&key=<string>&ArquivoID=<string>"); client.Timeout = -1; var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); } } }

Recomendamos o download da ferramenta POSTMAN caso queira ver a implementação da API em outras plataformas de programação, acesse:

• https://www.postman.com/downloads/
• Leia a licença de uso no site do POSTMAN.