27 APIs organizadas por categoria

Conheça a documentação de cada API — o que ela faz, parâmetros de chamada e campos de resposta. Para gerar seu token e integrar, solicite uma cotação.

Introdução

O que é a API

Uma API (Application Programming Interface) é um conjunto de comandos, funções, protocolos e objetos que os programadores podem usar para interagir com sistemas externos (como ERPs).

Ela fornece aos desenvolvedores de software comandos para extrair informações da LegisWeb de forma automatizada — como alíquotas, tributos e regras fiscais — que podem ser apresentadas ou inseridas diretamente no sistema do cliente.

As APIs visam extrair os dados e conteúdos processados pela LegisWeb de forma rápida e confiável para utilização em qualquer outro sistema. Elas são desenvolvidas no padrão REST (Representational State Transfer) e sua resposta se dá no formato JSON (JavaScript Object Notation), que consiste em um padrão de estrutura de dados para ser utilizado e convertido para qualquer sistema.

Cada API é acompanhada de sua documentação, detalhando seus métodos de consulta e atributos de retorno.

Integração API

A integração da API Legisweb com outro sistema é de responsabilidade do cliente. Caso você necessite que a integração seja feita a um sistema de terceiros, contratado por você, como um ERP, é a empresa que desenvolve este sistema que deverá proceder com a integração.

O que você vai encontrar na documentação da API

Todos os parâmetros de requisição e resposta da API são documentados:

  • Endpoint: o endereço da API e o método de chamada.
  • Parâmetros da chamada: quais informações enviar (obrigatórias e opcionais) e o que cada uma significa.
  • Campos da resposta: o que cada campo do JSON retornado representa.

Como o consumo é contabilizado

Cada contrato tem um limite mensal de consultas à API, contratado conforme a necessidade do cliente, que zera a cada virada de mês, ou seja, todo dia 01. Em regra, só é contabilizado como consumo uma consulta processada com sucesso, ou seja, com retorno de resultado. Se a consulta não retornar nenhum resultado o consumo não é contabilizado. Requisições rejeitadas (token inválido, parâmetro obrigatório faltando, etc.) não contabilizam consumo.

Parâmetros de autenticação: t e c

Toda chamada à API exige dois parâmetros na URL: t (o token) e c (o código de cliente, sempre numérico). O parâmetro c é o código numérico do cliente gerado pela LegisWeb. Usar qualquer outro valor no lugar do código de cliente resulta em Token ou código inválido.

Mensagens de erro da API

Mensagem / situaçãoO que verificar
Requisição Inválida. Faltou o token (t) ou o código de cliente (c) na chamada, ou nenhum parâmetro foi enviado.
Token ou código inválido. Confira se o token/código estão corretos, se o token não expirou, e se o módulo consultado está contratado.
Limite de consumo atingido. O limite mensal foi atingido. é possível habilitar consumo adicional ao gerar o token (ver Tabela de consumo excedente).
registros: 0 — "Nenhum resultado encontrado" Não é erro: a consulta funcionou, só não há registro para os parâmetros enviados. Tente pesquisar pela descrição e veja as Orientações de uso (sinônimos, NBS × NCM, TIPI).

APIs disponíveis

Estas são as APIs disponíveis, agrupadas por categoria. A documentação completa de cada uma — parâmetros de chamada e campos de resposta — está na navegação ao lado.

Pronto para integrar a LegisWeb ao seu sistema?

Fale com a LegisWeb

Dê o primeiro passo e solicite uma cotação: um de nossos especialistas entrará em contato para entender a necessidade do seu negócio e apresentar a melhor solução.