API Usuários

Autenticação para um Usuário

Método de Requisição: POSTCaminho: /api/token-manager/appKey=“Código do token”&key=””

Parâmetros:

 Nome Descrição  Tipo
 appkey  chave da aplicação  string
 key  chave da api  string
Ex: https://support.bimachine.com/evolucao-historica/api/token-manager?appKey=“Chave de Aplicação”&key=e71b35e5b236d5308349c1577a74e92dRespostas:
 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”: https://support.bimachine.com/evolucao-historica/api/token-manager?appKey=“Chave de aplicação”&key=“Chave de api”

BODY:
{

      “appKey”: “be5b11af905b62f8f5a5a037b2d5af48”,
      “email”: “tamires@sol7.com.br”
}
Resposta: Código 200:
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:https://support.bimachine.com/evolucao-historica?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:

Listar usuários

Caminho: /api/users/list?project={Nome do projeto}
Método de Requisição: GET
Resposta: Código 200 (se vier vazio o projeto não foi encontrado)Conteúdo da resposta:
{

“id“: 32,
“username“: “expert@expert.com”,
“email“: “expert@expert.com”,
“preferredLanguage“: “pt_BR”,
“displayName“: “Expert”,
“preferences“:{
“id“: 16,
“defaultProjectId“: null
},
“phone“: “”,
“projectLinks“: null,
“practiceProfile“:{
“id“: 2,
“name“: “Abastecedor de Máquinas”
},
“occupationArea“:{
“id“: 26,
“name“: “RH (Recursos Humanos)”
},
“dn“: null,
“superUser“: false,
“members“:[
32
]
},
{
“id“: 31,
“username“: “explorer@explorer.com”,
“email“: “explorer@explorer.com”,
“preferredLanguage“: “pt_BR”,
“displayName“: “Explorer”,
“preferences“:{
“id“: 17,
“defaultProjectId“: null
},
“phone“: “”,
“projectLinks“: null,
“practiceProfile“:{
“id“: 35,
“name“: “Agente de Aeroporto”
},
“occupationArea“:{
“id“: 6,
“name“: “Contabilidade”
},
“dn“: null,
“superUser“: false,
“members“:[
31
]
},
{
“id“: 7,
“username“: “suporte@sol7.com.br”,
“email“: “suporte@sol7.com.br”,
“preferredLanguage“: “pt_BR”,
“displayName“: “Suporte”,
“preferences“:{
“id“: 15,
“defaultProjectId“: null
},
“phone“: null,
“projectLinks“: null,
“practiceProfile“:{
“id“: 1,
“name“: “Abastecedor de Linha de Produção”
},
“occupationArea“:{
“id“: 1,
“name“: “Administrativo – Financeiro”
},
“dn“: null,
“superUser“: false,
“members“:[
7
]
},
{
“id“: 63,
“username“: “jennifer.vargas@bimachine.com.br”,
“email“: “jennifer.vargas@bimachine.com.br”,
“preferredLanguage“: “pt_BR”,
“displayName“: “Teste”,
“preferences“:{
“id“: null,
“defaultProjectId“: null
},
“phone“: “”,
“projectLinks“: null,
“practiceProfile“:{
“id“: 7,
“name“: “Adesivador”
},
“occupationArea“:{
“id“: 7,
“name“: “Contas a Pagar”
},
“dn“: null,
“superUser“: false,
“members“:[
63
]}

Criando um usuário

Método de requisição: POSTCaminho: api/users?appKey={Chave da API}

BODY: 
    {
        “email”: “desenvolvimentow@gmail.com”,
        “password”: “032015”,
        “preferredLanguage”: “pt_BR”,
        “displayName”: “desenvolvedora”,
        “phone”: “(49) 3242-12345”
    }
Resposta: 
  • Código 200 com sucesso
  • Código 409 indica que esse usuário já existe
Conteúdo das resposta com sucesso:
{
  “id”: 272,
  “username”: “desenvolvimento@gmail.com”,
  “email”: “desenvolvimento@gmail.com”,
  “preferredLanguage”: “pt_BR”,
  “displayName”: “desenvolvedor”,
  “viewTutorial”: false,
  “createObject”: false,
  “addData”: false,
  “preferences”: {
    “id”: 53,
    “defaultProjectId”: null,
    “defaultCockpits”: []
  },
  “phone”: “(49) 3242-12345”,
  “projectLinks”: null,
  “avatarLink”: “/avatar?user-id=272&i=1458133633110&oi=0”,
  “members”: [
    272
  ]
}
Informações do Usuário criado:
 Campo  Descrição Tipo
 id  Número Identificador  integer
 username  Nome  string
 email  E-mail  string
 preferredLanguage  Linguagem de Preferência  string
 preferences  Preferências  string
 phones  Contato  string
 projectLinks  Link do Projeto  string
 avatarLink  Link do Avatar  string
Informações do Erro 409:
 Campo  Descrição  Tipo
 status  Erro string
 message  Mensagem string
 statusCode  Código do erro integer

Removendo usuários

API – Permitir remoção de usuário de um projeto
Método de Requisição: DELETE
Caminho: /api/projects/{projectId}/users/{userId}
API – Autenticação Aplicações – Adicionar tempo de expiração aos tokens de usuário
Método de Requisição: DELETE 
Caminho:  /api/token-manager?invalidateToken=<token a ser invalidado>
Observação: O tempo normal é de 30 minutos para expirar.

Vinculando Usuário ao Projeto

Veja em: Listagem de Projetos Via Chave de Aplicação
Método de Requisição: POST
Caminho: /api/projects/{id do projeto}/users
Parâmetros:
 Nome Descrição  Tipo
 key  chave da api  string
Ex: http://bimachine.com.br/api/users?appKey=e71b35e5b236d5308349c1577a74e91dRespostas:

 Código  Descrição  Tipo
 200  Objeto de Usuário  Objeto (JSON)
Vinculando o Usuário:Para Vincular o usuário 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”: https://support.bimachine.com/evolucao-historica/api/projects/{id do projeto}/users?appKey=”Chave da API” passando no corpo da requisição (BODY) .

Ex: https://support.bimachine.com/evolucao-historica/api/projects/”Código do projeto”/users?appKey=“Chave da API”
BODY:
    {
        “userId”: 150,
        “permission”: “Viewer”
    }
Passo 2: 
Resultados esperados ao executar a chamada:
Código 200: Retorno de um objeto do usuário criado no BIMachine.
Conteúdo de Resposta:
Objeto de Vinculo do Usuário:
{
        “userId”: 150,
        “permission”: “Viewer”
}
Observação: No campo “permission”, é possível os seguintes valores: Administrador, Expert, Explorer e Viewer.

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

Método de Requisição: POST
Caminho: /api/token-managerParâmetros:

 Nome Descrição  Tipo
 appkey  chave da aplicação  string
 key  chave da api  string
Ex: https://support.bimachine.com/evolucao-historica/api/token-manager?appKey=a6225d1f9a78cc074f5284c5dc6728f0&key=e71b35e5b236d5308349c1577a74e92dRespostas:
 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”: https://support.bimachine.com/evolucao-historica/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: https://support.bimachine.com/evolucao-historica/api/token-manager?appKey=a6225d1f9a78cc074f5284c5dc6728f0&key=e71b35e5b236d5308349c1577a74e92d

Chave de API: e71b35e5b236d5308349c1577a74e92d
Chave de Aplicação: a6225d1f9a78cc074f5284c5dc6728f0    BODY:   {
      “appKey”: “be5b11af905b62f8f5a5a037b2d5af48”,
      “email”: “tamires@sol7.com.br”
   }
Resposta: Código 200
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: https://support.bimachine.com/evolucao-historica?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:

Artigos recentes

BIMachine Support

Rolar para cima