Skip to Content

MQTT

Pub/sub através de MQTT dentro do espaço de nomes da sua organização, com JWT ou credenciais estáticas

Última atualização em

As credenciais MQTT dão às integrações acesso pub/sub dentro do espaço de nomes de tópicos da sua organização. Cria as credenciais no Tillor em Conta > Programadores (por organização). O acesso aos tópicos limita-se a tillor/{env}/{orgId}/integration e subtópicos ({env} = prod, staging ou local), a menos que uma credencial estática tenha topicPrefix: null.

Para os mesmos eventos em tempo real que os webhooks e o SSE, utilize esses canais, não o MQTT.

Gestão

MétodoCaminhoDescrição
POST/api/orgs/:orgId/mqtt/credentialsGerar credenciais JWT (temporárias)
GET/api/orgs/:orgId/mqtt/static-credentialsObter credenciais estáticas
POST/api/orgs/:orgId/mqtt/static-credentialsCriar uma credencial estática
DELETE/api/orgs/:orgId/mqtt/static-credentials/:idEliminar uma credencial estática

Autenticação: x-api-key, com o ID da organização no caminho (como na API HTTP). Consulte a especificação OpenAPI para os esquemas completos de pedido e resposta.

Credenciais

Existem duas variantes:

JWT (temporário)

  • Utilização: Sessões curtas, acesso temporário
  • Validade: Por defeito 1 hora; configurável de 1 minuto a 24 horas através de expiresInSeconds
  • Ideal para: Testes, ligações temporárias, ou quando obtém tokens dinamicamente
  • Criação: No Tillor em Conta > Programadores, ou através de POST /api/orgs/:orgId/mqtt/credentials com, opcionalmente, { "clientId": "...", "expiresInSeconds": 3600 }
  • Resposta: token (use-o como palavra-passe MQTT), clientId, brokerUrl, topicPrefix, expiresAt
  • Nome de utilizador: Deixe vazio ao ligar; a autenticação JWT usa apenas o token como palavra-passe.
  • ID do cliente: Use exatamente o clientId da resposta ao ligar (incluindo o prefixo do ambiente, por ex. prod-).

Uma ligação ao broker através de mqtts verifica o certificado do servidor. Se usar um certificado de CA privada (não a cadeia pública habitual), coloque o PEM dessa CA no ambiente do seu cliente.

Credenciais estáticas

  • Utilização: Integrações de longa duração, ligações sempre ativas
  • Forma: userName, clientId e password fixos
  • Ideal para: Integrações de produção que permanecem continuamente ligadas
  • Criação: No Tillor em Conta > Programadores, ou através de POST /api/orgs/:orgId/mqtt/static-credentials com, opcionalmente, { "name": "mijn-integratie", "topicPrefix": null }
  • Resposta: userName, clientId, password (uma única vez), topicPrefix (null = sem prefixo, ACL #), opcionalmente brokerUrl
  • Atenção: A palavra-passe é mostrada uma única vez na resposta e não pode ser obtida novamente depois

Acesso a tópicos

As subscrições de tópicos são estritamente limitadas, a menos que topicPrefix seja null (ACL #). Por defeito, só pode publicar e subscrever tillor/{env}/{orgId}/integration e tillor/{env}/{orgId}/integration/#.

  • Tópicos permitidos - Apenas tillor/{env}/{orgId}/integration e subtópicos (por ex. tillor/{env}/{orgId}/integration/connector/access-point-operation)
  • Sem contornar com wildcards - Mesmo com # ou +, só tem acesso ao espaço de nomes da sua organização
  • Por organização - As credenciais são por organização; não tem acesso aos tópicos de outras organizações

Relacionado

  • OpenAPI - Especificação completa da API
  • API HTTP - API REST e chaves de API
  • Webhooks - Os mesmos eventos através de HTTP POST
  • SSE - Transmitir eventos através de Server-Sent Events
Esta página foi útil?

Nesta página