Pular para o conteúdo principal

Dispositivos

GET​

  • /devices

Retorna os dados dos dispositivos cadastrados no sistema de acordo com os parâmetros da requisição.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name (Opcional): Nome do dispositivo.
  • token (Opcional): Token do dispositivo.

Os parâmetros de filtragem são enviados na query string.

Caso id não seja passado na url, todos os dispositivos serão retornadas.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

Array<{
  creationTimestamp: Date;
  id: number;
  keyUpdateTimestamp: Date;
  name: string;
  recKey: {
    id: number;
    key: string;
  };
  token: string;
}>;

POST​

  • /devices

Cadastra um novo dispositivo no sistema.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name: Nome do dispositivo.
  • recKey: Chave criptográfica do dispositivo.
  • token: Token do dispositivo.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
 "recKey": string;
 "token": string;
}

O POST será responsável por criar a rec_key, caso não exista.

Resultado​

O resultado de uma requisição bem sucedida será um 201 Created com o seguinte formato:

Array<{
  creationTimestamp: Date;
  id: number;
  token: string;
}>;

PATCH​

  • /devices/:id

Atualiza os dados do device cuja o id é aquele passado na url.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name (Opcional): Nome do dispositivo.
  • recKey (Opcional): Chave criptográfica do dispositivo.
  • token (Opcional): Token do dispositivo.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
 "recKey": string;
 "token": string;
}

O PATCH será responsável por criar a recKey, caso não exista no banco de dados.

Resultado​

O resultado de uma requisição bem sucedida será um 204 No Content.