Este material tem como objetivo apresentar a API de forma conceitual, explicando quais consultas podem ser realizadas, além de orientar sobre a ativação do recurso e a geração das chaves no Sistema Tecnofit.
Conceitos
A arquitetura da API oferecida é RESTful, permitindo a comunicação entre sistemas seguindo os princípios da arquitetura REST (Representational State Transfer), um estilo de desenvolvimento de software baseado em recursos e operações padronizadas.
Características e requisitos
- JSON: Deve-se utilizar o formato JSON para a troca de informações, sendo necessária a definição explícita dos cabeçalhos
ContentTypeeAcceptem cada requisição. - Limite de requisições (rate limit): Na versão atual, cada endpoint individual está configurado com o limite de 100 requisições por minuto para cada IP, além de 200 requisições por minuto à nivel global da API.
- TLS 1.2: A arquitetura da api possui requisito mínimo de suporte ao protocolo
TLS 1.2+para realização das requisições. - Empresa Multiempresa: Nos cenários de uma empresa devidamente autenticada com as chaves do tipo "Integração Multiempresa", que tenha a necessidade de consultar informações de unidades/filiais em determinados endpoints, deve-se informar o ID da unidade no cabeçalho (header) customizado
X-Company-Idjunto à requisição.
Recomendações
Recomendamos que a implementação da integração com a API da Tecnofit seja realizada em um ambiente servidor seguro (backend), para que nenhuma chave ou dado sensível seja exposto.
Reforçamos também que a integração ocorre em ambiente de produção com dados reais da sua academia, refletindo ações e dados presentes no Sistema Tecnofit.
Por fim, realize apenas requisições minimamente necessárias e conforme indicadas na documentação de referência.