API do BI V2V
- Andersen Silva (Unlicensed)
- camilla.hossein (Unlicensed)
A nova API de BI do V2V tem por finalidade entregar ao cliente os dados do seu portal de forma rápida e segura. Esta API entrega arquivos no formato .json, é acessada via REST.
Para usufruir da api siga o passo a passo:
Cadastre as credenciais de acesso a api em ‘Configurações’>>'Credenciais':
Na pagina Credenciais localize o '+' e clique nele para adicionar uma nova credencial.
Escolha um nome para sua credencial
Em Mecanismos localize ‘REST’
Devemos primeiramente preencher os dados da aba Login.
URL onde deveremos realizar o login na aplicação
Metodo da requisição a ser realizada
Devemos preencher as credencias de autenticação
Os dois ultimos campos são tipos de autenticação
Na aba ‘Endpoints’ devemos preencher os campos necessarios para busca dos dados do seus sistema.
Variável | Significado | Onde encontrar |
|---|---|---|
Endpoint | URL de acesso a um determinado serviço | seu sistema deve te disponibilizar uma URL para conexão onde os dados serão disponibilizado |
Método | Protocolo HTTP | Ex.: ‘GET’, ‘POST’ |
Payload | Dados da Requisição | Username: “xxxxxxx” |
Resposta Espera | Resposta que deve retornar da requisição |
|
7. Na aba ‘Avançado’ podemos inserir os dados das outras duas abas em formato JSON da seguinte forma, assim realizando o preenchimento automatico das outras abas.
Json sem ‘endpoint filhos’
{
"login": {
"endpoint": "",
"method": "POST",
"payload": {
"username": "",
"userpassword": ""
},
"tokenPath": "token",
"tokenType": "Bearer "
},
"endpoints": [
{
"endpoint": "",
"method": "GET",
"response": {
"report_id": ""
}
}
]
}Json com 'endpoints filhos
{ "login": { "endpoint": "", "method": "POST", "payload": { "username": "", "userpassword": "" }, "tokenPath": "token", "tokenType": "Bearer " }, "endpoints": [ { "endpoint": "", "method": "GET", "response": { "report_id": "" }, "childs": [ { "endpoint": "", "method": "", "response": { "field_ids": "" } }, { "endpoint": "", "method": "GET", "response": { "custom_field_ids": "" }, "payload": { "company_id": "" } }, { "endpoint": "", "method": "GET", "payload": { "company_id": "", "field_ids": "", "custom_field_ids": "" } } ] } ] }Após preencher os dados insira no campo de texto na aba ‘Avançado’ e clique em ‘Atualizar campos’
7. Após salvar as credenciais devemos ir no menu ‘Vareduras’>>'Gerenciar'
8. Localize o '+' e clique nele para adicionar a varredura
9. Adicione um nome a varredura que deseja fazer
10. Clique no botão ‘Usar Credenciais’ e escolha a credencial que você cadastrou