Introdução

Esta documentação tem como objetivo detalhar o uso da API, contendo explicações da autenticação e pedidos comuns, bem como alguns exemplos em Json, criados em Postman exportados para OpenAPI.

Esta página fornece informações essenciais para começar a trabalhar com a API referenciada, utilizando duas ferramentas-chave: Swagger e Postman.

• Swagger: A documentação da API está disponível em OpenAPI e pode ser acessada através do link fornecido. Swagger auxilia na visualização e no download da documentação da API.

• Postman: Oferece uma maneira eficiente de realizar chamadas à API, simplificando a gestão de autenticação. Existem instruções fornecidas para importar um arquivo de configuração pronto no Postman, facilitando a configuração inicial.

Swagger

OpenAPI é atualmente o método standard de documentar APIs. Como tal, temos disponível no seguinte link, a documentação da referenciada API, em OpenAPI. Link para visualizar e descarregar OpenAPI:

https://app.swaggerhub.com/apis/toconline.pt/toc-online_open_api/1.0.0app.swaggerhub.com

https://app.swaggerhub.com/apis/toconline.pt/toc-online_open_api/1.0.0

Postman

Para facilitar o processo de configuração, disponibilizamos um arquivo pronto para importação no Postman. Este procedimento resume-se em dois passos simples:

1. Acesse a página de credenciais da API para obter o arquivo de configuração. Ele é fornecido via e-mail ao integrador escolhido.

2. Navegue até Empresa > Dados API, no nosso produto, para acessar e baixar o arquivo mencionado.