API
O Tiflux disponibiliza uma API onde você pode realizar consultas e enviar dados para o sistema via requisições HTTP.
Licença de acesso à API
Para obter acesso à API Tiflux, é necessário realizar a aquisição da licença de uso.
Para mais informações referente a contratação entre em contato com o nosso suporte!
Criando usuário e senha API
Ao realizar a contratação desta licença você precisará realizar as seguintes configurações:
Configurações > Geral > Integrações > Dados.
Insira um e-mail de acesso exclusivo do usuário analista de dados, clique em Salvar e-mail.
Você irá receber um e-mail para autorizar este e-mail como usuário de API, clique para autorizar.
Novamente no sistema, clique para gerar senha.
Sua senha será gerada abaixo do campo de e-mail. Guarde-a em um local seguro, ao sair desta tela você não terá mais acesso a ela.
Com o e-mail e senha acima gerados, você poderá utilizar autorização do tipo Basic Auth.
Você também poderá utilizar autenticação do tipo Basic/API Key Saiba mais em APIARY - Autenticação.
Limitações
A API Tiflux permite que você faça até 120 requisições por minuto, então caso precise fazer muitas requisiçoes seguidas recomendamos colocar um intervalo entre as requisições.
Códigos de resposta
Todas as respostas da API Tiflux vêm com um código de status HTTP. Cada código de status HTTP tem um significado, descrito abaixo.
200 OK - Solicitação realizada com sucesso.
201 Created - A solicitação foi realizada e seu objeto foi criado com sucesso.
400 Bad Request - Os parâmetros exigidos não foram enviados ou são inválidos. Neste caso, o corpo da resposta indicará qual é o problema.
401 Unauthorized - Sua API KEY não foi enviada ou é inválida.
404 Not Found - Endpoint ou objeto solicitado não existe
422 Unprocessable Entity - Ocorreu um erro ao tentar criar ou atualizar um objeto. O corpo da resposta indicará qual é o problema.
500 Internal Server Error - Algo deu errado na API Tiflux. Entre em contato com o suporte.
Todas as solicitações e respostas na API Tiflux estão no formato JSON.
Apiary Tiflux
Saiba mais sobre as possibilidades de consumo e requisições API através da nossa documentação.
Last updated
