<aside> <img src="/icons/code_red.svg" alt="/icons/code_red.svg" width="40px" /> Welcome to the Lumi Labs API Reference Guide! This comprehensive resource provides you with the tools and information you need to seamlessly integrate with our smart lighting ecosystem. This guide covers API endpoints, request/response formats, authentication mechanisms, error handling, and best practices to help you unlock the full potential of Lumi Labs.

</aside>

Primeiros Passos

1. Obtenha a Chave da API:

   • Para começar a usar a API da Lumi Labs, você precisará de uma chave da API. Registre-se para uma conta gratuita de desenvolvedor em nosso portal de desenvolvedores e crie uma chave da API.

2. Autenticação:

   • A API da Lumi Labs utiliza autenticação com Bearer Token. Inclua sua chave da API no cabeçalho Authorization de todas as requisições usando o seguinte formato:

   Authorization: Bearer SUA_CHAVE_DA_API

3. URL Base:

   • Todas as requisições da API devem ser enviadas para o seguinte URL base:

   https://api.lumilabs.com/v1

Endpoints da API

• Luzes

  • GET /lights: Obtenha uma lista de todas as luzes registradas.

  • GET /lights/{lightId}: Obtenha informações sobre uma luz específica.

  • PUT /lights/{lightId}/state: Atualize o estado de uma luz (ligada/desligada, brilho, cor, etc.).

    • Corpo da Requisição:

    JSON

    { "on": true, "brightness": 50, "color": { "hue": 240, "saturation": 80, "brightness": 100 } }

    Use o código com cautela.

  • POST /lights/{lightId}/effects: Aplique um efeito de iluminação a uma luz específica (por exemplo, pulsar, estroboscópico).

• Grupos
  • GET /groups: Obtenha uma lista de todos os grupos de luzes.
  • GET /groups/{groupId}: Obtenha informações sobre um grupo específico.
  • POST /groups: Crie um novo grupo.
  • PUT /groups/{groupId}: Atualize um grupo.
  • DELETE /groups/{groupId}: Exclua um grupo.
  • PUT /groups/{groupId}/action: Atualize o estado de todas as luzes em um grupo.
• Cenas
  • GET /scenes: Obtenha uma lista de todas as cenas criadas.
  • GET /scenes/{sceneId}: Obtenha informações sobre uma cena específica.
  • POST /scenes: Crie uma nova cena.
  • PUT /scenes/{sceneId}: Atualize uma cena.
  • DELETE /scenes/{sceneId}: Exclua uma cena.
  • POST /scenes/{sceneId}/activate: Ative uma cena.
• Uso de energia
  • GET /lights/{lightId}/energy: Obtenha estatísticas de uso de energia para uma luz específica.
  • GET /groups/{groupId}/energy: Obtenha estatísticas de uso de energia para um grupo de luzes.

Tratamento de erros

A API da Lumi Labs usa códigos de status HTTP padrão para indicar o sucesso ou falha de uma requisição. Aqui estão alguns códigos de erro comuns:

• 400 Bad Request: A requisição está mal escrita ou faltando parâmetros obrigatórios.
• 401 Unauthorized: A chave da API é inválida ou está faltando.
• 403 Forbidden: Você não tem permissão para realizar a ação solicitada.
• 404 Not Found: O recurso solicitado não pôde ser encontrado.
• 500 Internal Server Error: Ocorreu um erro inesperado no servidor.

Limitação de taxa

Para garantir a estabilidade e disponibilidade da API, implementamos limitação de taxa. Cada chave da API pode fazer 100 requisições por minuto. Se você exceder esse limite, suas requisições serão temporariamente restringidas com um código de status 429 Too Many Requests.

Melhores práticas