As APIs, ou Interfaces de Programação de Aplicações, são essenciais para estabelecer uma comunicação fluida entre diferentes sistemas. No caso do TPF, as APIs oferecem aos sistemas externos uma maneira estruturada e segura de acessar suas funcionalidades, incluindo a transmissão, cancelamento, inutilização e correção dos documentos eletrônicos.
Através das APIs do TPF, os usuários têm a possibilidade de integrar suas soluções diretamente ao TPF, garantindo uma maior eficiência no gerenciamento das obrigações fiscais e tributárias. Seja para a emissão de uma nova NF-e, a realização de operações mais complexas como a inutilização de notas, ou a emissão de Cartas de Correção, as APIs oferecem uma forma segura e consistente de interação.
O TPF disponibiliza um conjunto robusto de APIs, cada uma focada em um aspecto específico da gestão fiscal. Para acessar todas as APIs disponíveis, você pode visitar o Swagger do TPF, através do link:
https://plataformafiscal.totvs.com.br/api/swagger-ui.html#/
Para acessar e interagir com a API da Plataforma Fiscal, é necessário realizar a autenticação. Isso garante que apenas usuários autorizados tenham permissão para acessar e realizar operações com a API. A autenticação é feita através de um token, especificamente um Bearer Token.
Um Bearer Token é uma maneira de autenticação stateless onde o servidor não mantém nenhuma informação sobre o cliente entre as solicitações. O cliente deve enviar o token em cada solicitação, e esse token é suficiente para identificar e autenticar o cliente.
Para obter o token de autenticação, é preciso fazer uma requisição para o seguinte endpoint: plataformafiscal.totvs.com.br/api/v1/login, método: Post.
A requisição deve conter um payload (carga útil) com as seguintes informações:
Bloco de código | ||
---|---|---|
| ||
{
"username": "email-usuario",
"password": "senha-usuario"
} |
Onde email-usuario é o e-mail do usuário registrado na Plataforma Fiscal e senha-usuario é a respectiva senha.
Uma vez que a requisição é realizada corretamente, a Plataforma Fiscal retorna o Bearer Token, que deve ser incluído em todas as solicitações subsequentes para a API. Isso garante que o usuário esteja devidamente autenticado e possa interagir com as funcionalidades da API de maneira segura e controlada.
Exibir filhos |
---|