Bem-vindo à documentação oficial da API tiflux v2!

Com esta API, você poderá criar, visualizar, editar e excluir informações em sua base Tiflux. A versão 2 da nossa API é baseada nas permissões dos usuários, ou seja, você terá acesso apenas às rotas para as quais possui as devidas permissões.

Primeiros Passos

Este tutorial vai te guiar na obtenção de um token de acesso para realizar sua primeira requisição na API v2 do Tiflux.

Siga os passos abaixo para gerar seu token de autenticação:

1. Dentro do Tiflux, acesse as configurações da sua conta em: Configurações > Minha conta:

2. Clique na aba Sessões, localize a seção Sessões API e clique em Gerar sessão:

3. Após concluir o procedimento descrito acima, o seu token de autenticação da API será gerado.
No menu aberto, você poderá visualizar e copiar o token:

E pronto! Armazene o seu token com segurança. Você deve incluí-lo no cabeçalho de todas as requisições para a API, utilizando o seguinte formato:

Authorization: "Bearer <api-token>"

O que é um Bearer Token?

Um Bearer Token é como uma chave que permite o acesso a recursos protegidos em APIs. Ele é enviado junto com cada requisição para a API, informando quem você é e quais permissões você tem. Isso garante que apenas usuários autorizados possam acessar os dados e funcionalidades da API.

Como funciona?

1. Você pode obter seu token de acesso diretamente pela plataforma web do Tiflux. Para isso, acesse seu perfil e vá até: Minha Conta > Sessões
2. Este token é armazenado de forma segura no seu dispositivo.
3. A cada requisição para a API, você envia o token no cabeçalho de autorização.
4. A API verifica se o token é válido e se você tem permissão para acessar o recurso solicitado.
5. Se tudo estiver ok, a API retorna o que você pediu.
6. Se o token for inválido ou você não tiver permissão, a API te avisa.

Segurança:

Use HTTPS para comunicação segura.

Armazene o token de forma segura no seu dispositivo.

A API pode revogar tokens caso necessário.