API BI
- Tâmy de Souza (Unlicensed)
O método de autenticação para uso da API de BI é composto por login e senha de um operador do organizador, como Auth Basic + o token do organizador.
A API retorna os dados de todas unidades ou eventos vinculados ao organizador escolhido.
Como fazer:
1 - Acessar o cadastro do organizador e criar um usuário para configurar na autenticação Basic Auth:
Salvar os dados de acesso:
login:
senha:
2 - Copiar a API Key do organizador para utilizar como token na conexão:
Salvar API Key e informar junto do login e senha do passo anterior.
3 - Repassar para o cliente a documentação da API, atualmente temos 3 endpoints que podem ser utilizados como fontes de dados no BI.
Documentação: https://dev.frameticket.com.br/docs/bi
A apiUrl que deve ser utilizada (conforme documentação) é
https://api.[dominiodocliente].com.br/5.1, , e
1 - Configurar um dos endpoints disponíveis na documentação, nesse exemplo estou usando a lista de ingressos (/tickets)
Metodo: POST
Autorization Type: Basic Auth
Informar o login e a senha do operador do organizador.
2 - Incluir o token na Header da requisição:
Observe que em Autorization, por ser type Basic Auth, o postman converte em base64 os valores de login:senha
3 - Configurar no body os parametros que deseja para retornar os dados:
Adicionar uma nova conexão de dados do tipo de fonte de dados REST e configurar com os dados de autenticação do cliente.
Abaixo PDF para auxiliar cliente:
