BASE DE CONHECIMENTO

BIMachine ❱ API

Criando Usuário

Com essa funcionalidade, você pode criar usuários através da API. Veja abaixo as regras de utilização; 


Caminho: /api/users

Método de Requisição: POST


Parâmetros: 

 NomeDescrição  Tipo
 key chave da api string



Respostas:

 Código Descrição Tipo
 200 Objeto de Usuário Objeto (JSON)
 409 Objeto de Erro Objeto (JSON)


Criando o Usuário:


Para criar 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": http://app.bimachine.com.br/api/users?key={Chave da API} passando no corpo da requisição (BODY) um Objeto de Usuário.


    Ex: http://app.bimachine.com.br/api/users?key=e71b35e5b236d5308349c1577a74e92d


    Chave de API: e71b35e5b236d5308349c1577a74e92d


    BODY: 

    {

        "email": "desenvolvimentow@gmail.com",

        "password": "032015",

        "preferredLanguage": "pt_BR",

        "displayName": "desenvolvedora",

        "phone": "(49) 3242-12345" 

    }


Passo 2: 

    Resultados esperados ao executar a chamada:

    Código 200: Retorno de um objeto do usuário criado no BIMachine;

    Código 409: Retorno de um objeto de erro, indica que esse usuário já existe.


Conteúdo das respostas:


Objeto De Usuário


{

  "id": 272,

  "username": "desenvolvimentow@gmail.com",

  "email": "desenvolvimentow@gmail.com",

  "preferredLanguage": "pt_BR",

  "displayName": "desenvolvedora",

  "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 Objeto de Usuário:

 Campo DescriçãoTipo 
 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




Objeto de Erro:

{

  "status": "CONFLICT",

  "message": "The specified email <desenvolvimentow@gmail.com> is already in use, choose another one.",

  "statusCode": 409

}



 Campo Descrição Tipo
 status Errostring 
 message Mensagemstring 
 statusCode Código do errointeger