Canais
O que a licença destranca
Este módulo exige a funcionalidade canais na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.
Precisa de: armazem. Sem eles, este módulo não faz o que promete.
Aproveita: comercial, loja. Sem eles funciona, e faz menos.
Não se instala sem: armazem. É a ordem de arranque, e não a lista comercial.
Os 5 endpoints
Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.
| Método | Caminho | O que faz |
|---|---|---|
GET |
/api/v1/canais |
Lista os canais desta empresa |
POST |
/api/v1/canais |
Liga uma montra de fora |
PUT |
/api/v1/canais/:id |
Muda o nome, o armazém ou o estado de um canal |
POST |
/api/v1/canais/:id/rodar |
Troca o segredo do canal |
GET |
/api/v1/canais/registo |
O que os canais pediram, e o que aconteceu |
Esta página é gerada a partir do código do módulo, com make docs-modulos. O que aqui está muda no mesmo commit em que o módulo muda.