Ada.ia
Logo Base de Conhecimento

API Usuarios

Autenticación para un Usuario

Método de Requisición: POST

Camino: /api/token-manager/appKey="Código de token"&key=""

Parâmetros: 

 Nombre
Descripción 
 Tipo
 appkey
 Clave de aplicación
 string
 key
 Clave de la api
 string
Ej: http://app.bimachine.com.br/api/token-manager?appKey="Clave de Aplicación"&key=e71b35e5b236d5308349c1577a74e92dRespostas:
 Código
 Descripción
 Tipo
 200
 Objeto de Autenticación
 Objeto (JSON)
Para "generar la clave de autenticación vía API haga las siguientes aplicaciones:

Paso 1 :    

Utilizando el método de requisición POST haga la llamada REST para "url": http://app.bimachine.com.br/api/token-manager?appKey="Clave de aplicación"&key="Clave de api"

BODY:
{

      "appKey": "be5b11af905b62f8f5a5a037b2d5af48",
      "email": "tamires@sol7.com.br" 
}   
Respuesta: Código 200:
Contenido de la Respuesta: Objeto de Autenticación :
{
  "id": null,
  "applicationKey": {
    "id": 1,
    "name": "Aplicación presupuesto",
    "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
}
Accesando BIMachine con la Utilización del Token:
El "token": "c0cbc47fb041fa095b847eaa2c4c616e", retornado sirve para el usuario conseguir autenticarse BIMachine y debe ser pasado vía parámetro en la URL:
Ejemplo:http://app.bimachine.com.br?appToken=c0cbc47fb041fa095b847eaa2c4c616e
El Token Obtenido con la clave de aplicación y el e-mail del usuario también son válidos para exhibición de un objeto BIM (análisis, dashboard, kpi y mapas). Para eso basta entrar en BIMachine, acceder  el objeto que será exhibido y hacer clic sobre el  menú de publicación del objeto, marcar el habilitado y copiar el link generado o incorporarlo directamente.
Copie el código html generado y adicione al atributo: &appToken=c0cbc47fb041fa095b847eaa2c4c616e
Ejemplo de aplicación utilizando el ingreso vía token:

Listar usuarios

Camino: /api/users/list?project={Nombre drl proyecto} 
Método de Requisición: GET
Respuesta: Código 200 (se ve vacío el proyecto no fue encontrado)

Contenido de la respuesta:
{

"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 Aeropuerto"
},
"occupationArea":{
"id": 6,
"name": "Contabilidad"
},
"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 Línea de Producción"
},
"occupationArea":{
"id": 1,
"name": "Administrativo – Financiero"
},
"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": "Cuentas a Pagar"
},
"dn": null,
"superUser": false,
"members":[
63
]}

Creando un usuario

Método de requisición: POST

Camino: api/users?appKey={Clave del API} 

BODY: 
    {
        "email": "desenvolvimentow@gmail.com",
        "password": "032015",
        "preferredLanguage": "pt_BR",
        "displayName": "desenvolvedora",
        "phone": "(49) 3242-12345" 
    }
Respuesta: 
  • Código 200 con éxito
  • Código 409 indica que ese usuario ya existe
Contenido de las respuestas con éxito:

{
  "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
  ]
}
Informaciones del Usuario creado:
 Campo
 Descripción
Tipo 
 id
 Número Identificador
 integer
 username
 Nombre
 string
 email
 E-mail 
 string
 preferredLanguage
 Lenguaje de Preferencia
 string 
 preferences
 Preferencias
 string
 phones
 Contacto 
 string
 projectLinks
 Link del Projecto
 string
 avatarLink
 Link del Avatar
 string
Informaciones del Error 409:
 Campo
 Descripción
 Tipo
 status
 Error
string 
 message
 Mensaje
string 
 statusCode
 Código do error
integer 

Eliminando usuarios

API – Permitir eliminación de usuario de un projecto
Método de Requisición: DELETE 
Camino: /api/projects/{projectId}/users/{userId}
API – Autenticación Aplicaciones – Adicionar tiempo de expiración a los tokens de usuario
Método de Requisición: DELETE 
Camino:  /api/token-manager?invalidateToken=<token a ser invalidado>
Observación: El tiempo normal es de 30 minutos para expirar.

Vinculando Usuario al Proyecto

Método de Requisición: POST
Camino: /api/projects/{id do projeto}/users

Parámetros: 
 Nombre
Descripción
 Tipo
 key
  clave de api
 string
Ej: http://bimachine.com.br/api/users?appKey=e71b35e5b236d5308349c1577a74e91d

Respuestas:

 Código
 Descripción
 Tipo
 200
 Objeto de Usuario
 Objeto (JSON)
Vinculando el Usuario:

Para Vincular el usuario vía API haga las siguientes aplicaciones:

Paso 1 :    

Utilizando el método de requisición POST haga la llamada REST para "url": http://app.bimachine.com.br/api/projects/{id do projeto}/users?appKey="Clave de API" pasando en el cuerpo de la requisición (BODY) .

Ej: http://app.bimachine.com.br/api/projects/"Código del proyecto"/users?appKey="Clave de la API"
BODY:
    {
        "userId": 150,
        "permission": "Viewer" 
    }
Paso 2: 
    
Resultados esperados al ejecutar la llamada:
Código 200: Retorno de un objeto del usuario creando en BIMachine.
   
Contenido de Respuesta:
Objeto de Vinculo del Usuario: 
{
        "userId": 150,
        "permission": "Viewer" 
}
Observación: En el campo "permiso", es posible los siguientes valores: Administrador, Expert, Explorer y Viewer.

Generación de la Clave de Autenticación para un Usuario

Método de Requisición: POST
Camino: /api/token-manager

Parámetros: 

 Nombre
Descripción 
 Tipo
 appkey
 clave de aplicación
 string
 key
 clave de api
 string
Ej: http://app.bimachine.com.br/api/token-manager?appKey=a6225d1f9a78cc074f5284c5dc6728f0&key=e71b35e5b236d5308349c1577a74e92dRespostas:
 Código
 Descripción
 Tipo
 200
 Objeto de Autenticación
 Objeto (JSON)
Para "generar la clave de la autenticación vía API haga las siguientes aplicaciones:

Paso 1 :    

Utilizando el método de requisición POST haga la llamada REST para "url": http://app.bimachine.com.br/api/token-manager?appKey={chave de aplicação}&key={chave de api} pasando en el corpo de la requisición (BODY) un Objeto de Autenticación.   

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

   
Clave de API: e71b35e5b236d5308349c1577a74e92d
Clave de Aplicación: a6225d1f9a78cc074f5284c5dc6728f0    BODY:   {
      "appKey": "be5b11af905b62f8f5a5a037b2d5af48",
      "email": "tamires@sol7.com.br" 
   }   
Respuesta: Código 200
Contenido de la Respuesta: Objeto de Autenticación:
{
  "id": null,
  "applicationKey": {
    "id": 1,
    "name": "Aplicación presupuesto",
    "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
}
Ingresando BIMachine con la Utilización del Token:
El "token": "c0cbc47fb041fa095b847eaa2c4c616e", retornado sirve para el usuario conseguir autenticar en BIMachine y debe ser pasado vía parámetroen la URL:
EJemplo: http://app.bimachine.com.br?appToken=c0cbc47fb041fa095b847eaa2c4c616e
El Token Obtenido con la clave de la aplicación y el e-mail del usuario también son válidos para exhibición de un objeto BIM (análisis, dashboard, kpi y mapas). Para eso basta entrar en BIMachine, ingresar el objeto que será exhibido y hacer clic sobre el menú de publicación del objeto, marcar el habilitado y copiar el link generado o incorporarlo directamente.
Copie el código html generado y adicione el atributo: &appToken=c0cbc47fb041fa095b847eaa2c4c616e
Ejemplo de aplicación utilizando el ingreso vía token:

Ultimos artículos

BIMachine Support

Scroll al inicio