API e integrações

4 min de leitura

Sistema de gestão, mensageiro, webhook de entrada com chave de API e o que é tratado na implantação.

Estas são as integrações que a plataforma tem hoje. Integrações sob medida, com sistemas que não estão nesta lista, são avaliadas e tratadas na implantação.

Integração	Para que serve	Autenticação
Sistema de gestão do provedor	Nome, contrato, plano, login PPPoE, situação financeira e sessões do assinante ao lado da ONU	Chave ou credencial fornecida pelo seu sistema, guardada cifrada
Mensageiro	Alertas em grupo, reconhecimento, consultas e ações com código	Bot da instância e contas vinculadas a usuários
Webhook de entrada	Sistemas externos abrem eventos na central de operações	Chave de API de usuário administrador
Servidor TR-069 (ACS)	Painel e ações de TR-069 na ficha do assinante	Servidor TR-069 da plataforma, instalado na implantação, em operação
Copiloto	Perguntas em português sobre a planta	A chave de API de IA do próprio provedor, com teto de gasto
Backup por e-mail	Envio da cópia de configuração da plataforma	Servidor de e-mail configurado pelo administrador

Sistema de gestão

A integração funciona com qualquer sistema de gestão que tenha API. Os mais usados por provedores já vêm prontos; um sistema ainda não conectado é ligado pela API dele durante a implantação.
Um provedor pode ter mais de uma base de clientes (uma por empresa atendida).
A plataforma testa a chave antes de salvar e nunca a exibe de volta.
A integração é de consulta: cadastro e cobrança continuam no seu sistema de gestão.

Webhook de entrada

O webhook recebe eventos de um sistema externo (outro monitoramento, um sistema de chamados, um script da sua equipe) e os transforma em episódios na central de operações. Eventos de gravidade atenção ou crítica também seguem o plano de envio de alertas.

Um administrador gera uma chave de API na área de chaves da conta, com um nome e, se quiser, uma validade em dias.
Copie a chave quando ela for exibida. Depois, a lista mostra só o prefixo dela.
O endereço do webhook da sua instância é informado ao administrador pela plataforma.
Envie os eventos por POST, em JSON, com a chave no cabeçalho de autorização, no formato Bearer.
Quando a chave não for mais necessária, revogue-a na mesma área.

Campo	Obrigatório	Uso
title	Sim	Título do evento
severity	Não	critical, attention ou healthy; valores desconhecidos viram attention
eventType	Não	Tipo do evento, para agrupar e filtrar
detail	Não	Descrição do que aconteceu
assetType	Não	olt, network-host ou platform
assetKey / host / oltId	Não	Qual equipamento o evento envolve
recommendations	Não	Lista de ações recomendadas
dedupeKey	Não	Chave para não duplicar o mesmo evento
capturedAt	Não	Quando o evento foi observado na origem
meta	Não	Objeto livre com dados da origem, como número de chamado

Exemplo de corpo do evento

{
  "title": "Falha de autenticação PPPoE",
  "eventType": "pppoe-auth-failure",
  "severity": "attention",
  "assetType": "olt",
  "detail": "Sessões recusadas depois de mudança no servidor de autenticação.",
  "recommendations": ["Conferir o domínio", "Conferir o grupo de autenticação"],
  "dedupeKey": "chamado-2048"
}

Resposta	Significado
202	Evento aceito; a resposta traz o número do episódio criado
400	JSON inválido ou falta o campo title
401	Chave ausente, inválida, revogada ou vencida

A chave de API age em nome do usuário que a gerou, e cada evento recebido fica na auditoria com esse usuário. Trate a chave como senha: não a coloque em repositório de código nem em mensagem.

O que não existe hoje

Não há catálogo público de API para consultar ou alterar dados da plataforma por sistemas externos, nem webhook de saída com catálogo de eventos. Necessidades desse tipo são tratadas na implantação.
Não há alerta por e-mail, SMS ou aviso direto ao assinante.
A plataforma não fornece servidor de autenticação próprio. O servidor TR-069 (ACS) é da plataforma.

Ficou alguma dúvida?A equipe que faz a implantação responde.

Perguntar no WhatsApp

API e integrações

Sistema de gestão

Webhook de entrada

O que não existe hoje

Leia também