BASE DE CONHECIMENTO

BIMachine ❱ API

Geração da Chave de Autenticação para um Usuário

Ao fazer uma requisição POST para a API passando a chave de aplicação e o e-mail do usuário cadastrado, o BImachine irá gerar essa chave de autenticação. 

Veja como:

Caminho: /api/token-manager

Método de Requisição: POST


Parâmetros: 

 NomeDescrição  Tipo
 appkey chave da aplicação string
 key chave da api string


Ex: http://app.bimachine.com.br/api/token-manager?appKey=a6225d1f9a78cc074f5284c5dc6728f0&key=e71b35e5b236d5308349c1577a74e92d


Respostas:

 Código Descrição Tipo
 200 Objeto de Autenticação Objeto (JSON)


Para "gerar a chave de autenticação via API faça as seguintes aplicações:


Passo 1 : 

    Utilizando o método de requisição POST faça a chamada REST para "URL": http://app.bimachine.com.br/api/token-manager?appKey={chave de aplicação}&key={chave de API} passando no corpo da requisição (BODY) um Objeto de Autenticação.


    Ex: http://app.bimachine.com.br/api/token-manager?appKey=a6225d1f9a78cc074f5284c5dc6728f0&key=e71b35e5b236d5308349c1577a74e92d

    Chave de API: e71b35e5b236d5308349c1577a74e92d

    Chave de Aplicação: a6225d1f9a78cc074f5284c5dc6728f0


    BODY:


   {

      "appKey": "be5b11af905b62f8f5a5a037b2d5af48",

      "email": "tamires@sol7.com.br" 

   }   


Passo 2: 

    Resultados esperados ao executar a chamada:

    Código 200: Retorno de um objeto de autenticação criado no BIMachine;

    

Conteúdo de Resposta:

Objeto de Autenticação :


{  "id": null,  "applicationKey": {    "id": 1,    "name": "Aplicação orçamento",    "token": "be5b11af905b62f8f5a5a037b2d5af48",    "account": {      "id": 38,      "accountOwnerId": 85,      "accountMasterId": 85,      "applicationKeys": null,      "name": "Ciço"    },    "blockByDomain": false,    "allowedDomains": null  },  "user": {    "id": 159,    "username": "tamires@sol7.com.br",    "email": "tamires@sol7.com.br",    "preferredLanguage": "pt_BR",    "displayName": "Tamires Lopes Johann",    "viewTutorial": false,    "createObject": false,    "addData": false,    "preferences": {      "id": 36,      "defaultProjectId": null,      "defaultCockpits": null    },    "phone": "",    "projectLinks": null,    "avatarLink": "/avatar?user-id=159&i=1458152305726&oi=0",    "members": [      159    ]  },  "token": "c0cbc47fb041fa095b847eaa2c4c616e",  "expires": 1458155323433}



Acessando BImachine com a Utilização do Token:


O "token": "c0cbc47fb041fa095b847eaa2c4c616e", retornado serve para o usuário conseguir autenticar no BIMachine e deve ser passado via parâmetro na URL;


Exemplo: http://app.bimachine.com.br?appToken=c0cbc47fb041fa095b847eaa2c4c616e


O Token Obtido com a chave de aplicação e o e-mail do usuário também são válidos para exibição de um objeto BIM (análise, dashboard, KPI e mapas). Para isso basta entrar no BIMachine, acessar o objeto que será exibido e clicar sobre o menu de publicação do objeto, marcar o habilitado e copiar o link gerado ou incorporá-lo diretamente.


Copie o código html gerado e adicione o atributo: &appToken=c0cbc47fb041fa095b847eaa2c4c616e


Exemplo de aplicação utilizando o acesso via token: