TOConline - Documentação API
  • Introdução
  • Setup do Postman
  • Autenticação Simplificada
  • Autenticação Detalhada
  • Características dos pedidos
  • APIs
    • Empresa
      • Clientes, Morada e E-mail
      • Fornecedores, Morada e E-mail
      • Produtos e Serviços
    • Vendas
      • Documentos de Venda
      • Documentos Retificativos
      • Recibos de Venda
      • Descarregar PDF de Documentos de Venda
      • Descarregar PDF de Recibo
      • Comunicação de documentos à AT
      • Envio de Documentos por email
      • Envio de Recibos por email
    • Compras
      • Documentos de Compra
      • Pagamentos
      • Descarregar PDF de Documentos de Compra
      • Descarregar PDF de Pagamentos
      • Comunicação de documentos à AT
    • Versões Anteriores
      • Vendas
        • Documentos de Venda
        • Recibos de Venda
      • Compras
        • Documentos de Compra
        • Pagamentos
    • APIs Auxiliares
      • Descritores de Taxa
      • Família de Itens
      • Países
      • Unidades de Medida
      • Contas Bancárias
      • Caixa Associada
      • Unidade Monetária
      • Taxas
      • Categorias de Despesa
      • Documentos de Série
Powered by GitBook
On this page
  • Swagger
  • Postman

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.

NextSetup do Postman

Last updated 10 months ago

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:

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.

Build, Collaborate & Integrate APIs | SwaggerHub
https://app.swaggerhub.com/apis/toconline.pt/toc-online_open_api/1.0.0
Logo