Etiquetas e QR Code
Gerar a lista de etiquetas (com a URL do QR Code) de equipamentos, áreas ou unidades, para impressão ou conferência.
GET /v1/etiquetas lista os itens de um dos três tipos de etiqueta, já com a URL do QR Code pronta para impressão. É um endpoint só de leitura — não existe cadastro de etiqueta via API, o QR é derivado do próprio equipamento/área/unidade.
Parâmetro Tipo (obrigatório)
| Valor | Retorna etiquetas de |
|---|---|
equipamento | Equipamentos |
area | Áreas |
unidade | Unidades |
Valor ausente ou fora dessa lista retorna 400.
curl "https://lighthousev2.lkp.app.br/v1/etiquetas?Tipo=equipamento&PageSize=100" \
-H "Authorization: Bearer SEU_TOKEN"
Formato da URL do QR
O campo url de cada item segue {base}/{prefixo}_{id}, com o prefixo variando por tipo:
| Tipo | Prefixo | Exemplo |
|---|---|---|
equipamento | E_ | https://qr.lkp.app.br/E_4521 |
area | A_ | https://qr.lkp.app.br/A_318 |
unidade | S_ | https://qr.lkp.app.br/S_12 |
A base é configurada por ambiente (sandbox e produção resolvem em domínios diferentes) — não assuma um domínio fixo, use sempre o valor de url retornado pela API.
Matriz de campos por tipo
EtiquetaItem tem sempre os mesmos 8 campos; os que não se aplicam ao Tipo pedido vêm null (é um null esperado, não ausência de dado):
| Campo | equipamento | area | unidade |
|---|---|---|---|
nomeEquipamento | preenchido | null | null |
tagEquipamento | preenchido | null | null |
nomeArea | preenchido (área do equipamento) | preenchido | null |
nomeUnidade | preenchido | preenchido | preenchido |
identificacaoAmbiente | espelha a área do equipamento, se cadastrada | preenchido, se cadastrado | null |
nomeGrupoArea | espelha o grupo da área do equipamento, se cadastrado | preenchido, se cadastrado | null (unidade não tem grupo de área) |
id e url são sempre preenchidos, independentemente do tipo.
Filtros e paginação
Além de Tipo, o endpoint aceita os mesmos filtros geográficos e de escopo do padrão /v1/equipamentos (UnidadeId, AreaId, GrupoAreaId, EquipamentoId, Search etc. — ver Glossário de IDs e enums). Nem todo filtro se aplica a todo Tipo: um filtro de equipamento (ex.: TipoEquipamentoId) é ignorado silenciosamente ao listar Tipo=unidade, não gera erro.
PageIndex: começa em1.PageSize: padrão100, máximo500— acima disso o endpoint responde400.totalCountsó vem preenchido na página 1 (PageIndex=1); nas demais páginas o campo existe na resposta mas com valornull.
Erro de acesso (403)
Se algum UnidadeId/AreaId do filtro n ão estiver no escopo de acesso do usuário autenticado, a resposta é 403 Forbidden com { "message": "..." } — não é o ProblemDetails padrão dos demais 401/500. Sem filtro explícito de unidade/área, a listagem já vem restrita automaticamente ao que o usuário pode ver.
Dicas para IA / integração
Tipoé o único parâmetro realmente obrigatório — todo o resto é filtro opcional.- Não tente montar a URL do QR na mão a partir do
id— use sempre o campourlda resposta (a base muda por ambiente). - Para imprimir etiquetas em lote, pagine com
PageSize=500(o máximo) e combine com os filtros geográficos para reduzir o volume por página.