Estudo sobre a API

Apresentação.

Documentação da API RESTful com Python Flask desenvolvida para aplicação web do projeto integrador da equipe MO Technology do curso superior de engenharia de telecomunicações.

Autenticação.

A autenticação será feita na própria requisição, através de campos informados dentro do corpo da mesma (em formato JSON).

Formato de entradas e saídas

Caso de leitura dos dados

Entradas GET:
O cliente HTTP poderá fazer a requisição do método de duas formas:
1 - Sem solicitar um recurso em específico;
2 - Solicitando um recurso específico, por exemplo, as leituras de um arduino único arduino.

Saídas:
1 - 200 Ok no caso de sucesso;
2 - 400 Bad Request em caso de inconsistências na URL.
3 - 404 Not Found no caso de requisição de recursos inexistentes.

Caso de escrita dos dados

Entrada: POST + JSON.
Formato do JSON: {id: “123”, u: “60”, t: “25”, tm: “123456789” }. Onde cada campo representa, respectivamente: identificação do arduino, umidade, temperatura e timestamp.

Saídas:
1 - 200 Ok no caso de sucesso;
2 - 201 Creat no caso de inserção de uma nova medida
3 - 400 Bad Request em caso de inconsistências na URL;
4 - 401 Unathorized caso um o arduino que encaminhou as medidas para o módulo transmissor não esteja previamente cadastrado no banco de dados;

Métodos de solicitação HTTP.

Como serão usados os métodos HTTP utilizados pelos usuários do sistema: