Skip to content
Last updated

Integre-se ao Radar de Eventos da Broadcast

O Broadcast® Radar API integra busca e monitoramento de eventos do ecossistema Agência-Estado/Broadcast

A AE Broadcast® disponibiliza o Broadcast Radar API para consolidar, em uma única interface, eventos informativos extraídos de portais jornalísticos, redes sociais, plataformas institucionais e outras fontes especializadas. Por meio de mecanismos de varredura contínua e coleta de conteúdo original, a API oferece dados estruturados que podem ser consumidos por sistemas externos em formato JSON. Cada evento captura metadados essenciais — como título, resumo, timestamp, autor, URL de referência e tags de categoria — garantindo a máxima assertividade na entrega das informações.

A solução abrange funcionalidades avançadas de enriquecimento dos dados coletados:

  • Normalização de fontes:
    Unifica formatos de publicação de diferentes canais, garantindo consistência no payload enviado;
  • Classificação semântica:
    Aplica modelos de NLP para identificar assunto principal, sentimento e possíveis tendências emergentes;
  • Agrupamento e deduplicação:
    Evita múltiplas notificações sobre o mesmo evento, reduzindo ruído e melhorando a precisão analítica;
  • Controle de qualidade:
    Validações automáticas asseguram que somente conteúdo original seja indexado, eliminando republicações ou spams.

Objetivo

O Broadcast Radar API é uma plataforma de inteligência de mídia cruzada (CMI) que fornece acesso a eventos de múltiplas fontes de mídias. Seu propósito central é:

  1.  Orquestrar captura inteligente de eventos jornalísticos, sociais e institucionais através de filtros semânticos configuráveis;
  2.  Automatizar detecção estratégica via monitores programáveis com controle de janelas temporais e gatilhos de notificação;
  3.  Executar refinamento dos filtros mediante consultas ad-hoc sobre o acervo histórico e atual;
  4.  Garantir entrega verificável mediante assinaturas HMAC e protocolos seguros para webhooks;
  5.  Facilitar integração corporativa em sistemas analíticos, painéis executivos e fluxos de decisão.

Assim, a API visa atender demandas de instituições financeiras, agências de comunicação, plataformas de inteligência de mercado e qualquer projeto que necessite de acesso rápido e confiável a notícias e publicações relevantes para tomada de decisão. Por meio de sua arquitetura escalável, baseada em padrões abertos, garante-se alta disponibilidade, segurança (autenticação via OAuth2/JWT) e facilidade de evolução para novos casos de uso.

Funcionalidades Principais

A API disponibiliza recursos e operações para:

  1.  Gestão de Filtros Semânticos

    • Modelagem de critérios avançados com requiredTerms, unwantedTerms e optionalTerms
    • Seleção de fontes via listas de inclusão (searchSources) e exclusão (excludeSources)
    • Parâmetros temporais (publishedFrom/Until) e ordenação por relevância/data
  2.  Operação de Monitoramentos

    • Associação dinâmica de filtros a monitores ativos;
    • Configuração de janelas de captura (captureStart/Stop) e periodicidade (notifyEveryHours)
    • Controle de estado (active/inactive) e dias de notificação (daily/workDays)
  3.  Execução de Pesquisas Sob Demanda (Novo)

    • Consultas ad-hoc via searchFilterId (filtros existentes) ou alertId (contexto de alertas)
    • Paginação granular (pageSize, pageNumber) e ordenação (relevance/dateAsc/dateDesc)
    • Metadados enriquecidos (sentimento, entidades, tópicos) em respostas estruturadas
  4.  Configuração Segura de Webhooks

    • Registro de endpoints HTTPS com rotação de chaves HMAC (rotateSecurityKey);
    • Validação de payloads via X-Broadcast-Signature;
    • Mecanismo de retentativas exponenciais para falhas.
  5.  Sistema de Notificação Estruturada

    • Payloads normalizados com alertId, searchFilterId, contentCount e timestamp;
    • Protocolo de resposta exigindo HTTP 200 em <5s para confirmação.

Esse recursos asseguram escalabilidade para cenários como tracking de marca, early warnings setoriais e curadoria de tendências, mantendo compliance e robustez operacional.

Benefícios da Solução

  • Alta Agilidade na Coleta de Informações: permite que equipes recebam alertas ou executem buscas ad-hoc após eventos relevantes, reduzindo o tempo de resposta a crises/oportunidades;
  • Precisão Aumentada por Filtros Inteligentes: combinação de filtros semânticos com capacidade de teste prévio via /search, garantindo alta precisão antes da ativação de monitores;
  • Escalabilidade Operacional: arquitetura dual-mode (monitoramento contínuo + buscas pontuais) atende desde tracking permanente até investigações emergenciais sem sobrecarga;
  • Flexibilidade Analítica: dupla via de consumo - streaming via webhooks para alertas e JSON sob demanda para dashboards/relatórios com metadados enriquecidos (sentimento, entidades);
  • Ciclo Completo de Inteligência: investigação reativa (/search) e integração contínua entre detecção proativa (/monitors), cobrindo todo o espectro decisório (veja em Fluxo de Trabalho).

Fluxo de Trabalho

A Broadcast Radar API pode ser dividida em dois fluxos de trabalho principais de operação:

Fluxo 1: Busca Sob Demanda (Reativo)

  1.  Disparo de Consultas
    • Pesquisas por searchFilterId (filtros existentes)
    • Investigação por alertId (contexto de alertas)
  2.  Refinamento Iterativo
    • Ajuste de parâmetros (pageSize, sortBy)
    • Paginação granular (pageNumber)
  3.  Análise Imediata
    • Acesso a metadados enriquecidos (sentimento, entidades)
    • Exportação direta para sistemas analíticos

Fluxo 2: Monitoramento Contínuo (Proativo)

  1.  Configuração de Filtros após o refinamento

    • Definição de critérios semânticos (requiredTerms, unwantedTerms)
    • Seleção de fontes (searchSources/excludeSources)
    • Parâmetros temporais (publishedFrom/Until)
  2.  Associação a Monitores

    • Programação de janelas de captura (captureStart/Stop)
    • Definição de periodicidade (notifyEveryHours)
    • Configuração de notificações (daily/workDays)
  3.  Configuração de Webhooks (Receptor)

    • Registro do endpoint HTTPS que ficará hospedado na infraestrutura do cliente
    • Geração e troca da chave de assinatura compartilhada (HMAC) via operação rotateSecurityKey
    • Definição das políticas de retry e tempo‐limite de confirmação (HTTP 200 em até 5 s)
  4.  Detecção e Notificação

    • Varredura automática nas fontes selecionadas
    • Geração de alertas com payload normalizado (alertId, searchFilterId, contentCount, timestamp)
    • Entrega verificada: inclusão de cabeçalho X-Broadcast-Signature + retentativa exponencial em caso de falha

Camada Unificada de Integração

  • APIs RESTful: acesso unificado a recursos de filtros, monitores e buscas;
  • Webhooks Seguros: entrega de notificações com assinatura HMAC e retentativas;
  • Canais Corporativos: integração nativa com BI tools, data lakes e sistemas de decisão via JSON estruturado.

Referência da API

A Referência da API fornece documentação detalhada de cada endpoint, parâmetros de entrada, respostas de saída e exemplos práticos de uso. Ela serve como manual de consulta para desenvolvedores que desejam integrar seus sistemas à Broadcast Radar API. A seguir, os principais aspectos abordados:

  1.  Paths e Operações

    • Lista de todos os recursos disponíveis (ex: /filters, /monitors, /search, /configuration);
    • Para cada recurso, estão definidas as operações HTTP suportadas (GET, POST, PUT, DELETE);
    • Exemplos de chamada com cabeçalhos obrigatórios (incluindo Authorization: Bearer <token>) e payload do requisição e da resposta em JSON.
  2.  Modelos de Dados (Schemas)

    • Definições completas dos objetos JSON utilizados em entradas e saídas, com tipos de dados, obrigatoriedade de campos e exemplos;
      • Requisições: modelos de requisição para criação e atualização de filtros, monitores e configurações;
      • Respostas: modelos de resposta de todas as operações da API, com exemplos de payloads retornados;
      • Domínio: modelos de domínio que definem entidades principais como FilterBase, MonitorBase, SearchResult, etc.
    • Enumerações de valores permitidos (ex: sortCriteria aceita os valores relevance, date, popularity);
    • Parâmetros de paginação, ordenação e metadados em listagem (pageSize, pageNumber, totalResults, totalPages, orderBy, etc.).
  3.  Códigos de Resposta e Tratamento de Erros

    • Códigos HTTP devolvidos (200, 201, 204, 400, 401, 404) e significado de cada um nas respostas das operações;
    • Validação de erros padronizado (validationErrors), contendo detalhes para orientar o que deve ser corrigido na requisição.
  4.  Autenticação e Segurança

    • Definição dos securitySchemes referenciados, incluindo:
      • ApiKey: Para autenticação via chave de API com credenciais de acesso (obtém o bearer token);
      • BearerToken: Para autenticação via token JWT, como suporte renovar tokens (refresh token flow);
      • HmacSignature: Para validacão de assinaturas HMAC em webhooks, garantindo notificações integras e confiáveis;
    • Exemplos de fluxos de obtenção de token via POST /auth/sessions e renovação em PUT /auth/session/{sessionId}.
  5.  Exemplos Práticos de Integração

    • Códigos de exemplo em cURL e bibliotecas populares (ex: JavaScript/Node.js, Python, C#) para as operações mais comuns (criar fonte, configurar filtro, iniciar monitor, buscar eventos);
    • Trechos de resposta JSON realistas para ilustrar a estrutura dos objetos retornados em diferentes cenários (nenhum evento, múltiplos eventos, event streaming);
    • Execução de chamadas de teste (sandbox/mockup) integrada nas referências de cada operação, permitindo que desenvolvedores validem rapidamente a sintaxe e o formato das requisições.
  6.  Versão e Controle de Mudanças

    • Protocolo de versionamento semântico (major.minor.patch) utilizado nos releases da API;
    • Notas de versão e changelog para documentar alterações significativas em endpoints, esquemas e regras de negócio.

A seção Referência da API deve ser consultada sempre que for necessário entender detalhadamente como utilizar cada funcionalidade, quais campos são obrigatórios, quais valores são esperados e como tratar possíveis erros em tempo de execução.