Requisição e Resposta

Todas as chamadas da API devem ser feitas para /api/endPoint e irão retornar uma resposta no formato de JSON.

Clique aqui para visualizar os EndPoints da API.

Exemplo

$ curl -i https://automacao-iot.com.br/api/

HTTP/1.0 200 OK
Date Mon, 27 Mar 2017 01:39:36 GMT
Content-Type: application/json
Content-Language: en
Allow: GET

{
    "success": true,
    "payload": {
        "version": "1.0.0"
    },
    "message": "This is the ultimate API!"
}

Métodos HTTP

Tentamos seguir as convenções de HTTP ao máximo, mas as vezes podemos estar sacrificando a formalidade por funcionalidades.

Método	Descrição
GET	Usado para consulta de dados.
POST	Usado para criação de dados
PUT	Usado para atualização de dados
DELETE	Usado para deletar dados

Códigos HTTP

O código de operação da requisição HTTP indica a situação da operação em questão.

Você pode conferir esses códigos aqui.

Resposta

Para todas as requisições a API irá retornar uma resposta no formato de um JSON. Essas respostas seguem um modelo padronizado que explicaremos abaixo.

Veja aqui os Response Models que a API pode retornar.

Chave	Tipo	Anulável	Significado
success	boolean	Não	Operação da Requisição foi feita com Sucesso.
payload	Nested Json Object ou Nested Json Array	Sim	Resultado da Operação que podem vir na forma de um JSON Object ou um JSON Array.
message	string	Não	Mensagem Informacional.