Integração com a API REST do Oktopus

Integrando seus sistemas com a API REST do Oktopus

As operações de um ISP hoje dependem de muitos sistemas diferentes trabalhando em conjunto: CRM, plataformas de faturamento, ferramentas de suporte, software de monitoramento e, no centro de tudo, o ACS. Quando esses sistemas não estão conectados corretamente, as equipes acabam dependendo de processos manuais, dados duplicados e visibilidade fragmentada. Esse atrito torna as operações mais lentas e dificulta o escalonamento mais do que deveria.

No Oktopus, vemos o ACS como algo além de apenas uma ferramenta de gerenciamento de dispositivos. Ele deve atuar como a espinha dorsal da sua operação, capaz de se comunicar naturalmente com todos os outros sistemas dos quais você depende. É exatamente isso que a API REST do Oktopus foi projetada para fazer.

Neste artigo, juntamente com o vídeo incorporado abaixo, explicamos como integrar sistemas externos ao Oktopus e como essa integração pode desbloquear automação, consistência e eficiência operacional.

Vídeo: Como integrar com a API REST do Oktopus

Por que a integração via API é tão importante para ISPs

À medida que os ISPs crescem, a complexidade cresce com eles. Novos fornecedores são introduzidos, equipes de suporte se expandem e as expectativas dos clientes aumentam. Sem integrações sólidas, tarefas diárias como provisionamento, resolução de problemas ou relatórios tornam-se lentas e propensas a erros.

Uma API bem projetada permite que seus sistemas compartilhem dados em tempo real. Seu CRM pode acionar o provisionamento, sua plataforma de suporte pode extrair diagnósticos ao vivo e seu sistema de faturamento pode permanecer alinhado com o estado real dos dispositivos em campo. Em vez de as equipes trabalharem em torno das ferramentas, as ferramentas começam a trabalhar para as equipes.

Acessando a documentação da API do Oktopus

O primeiro passo para integrar com o Oktopus é familiarizar-se com a documentação da API.

Toda a documentação está disponível em https://docs.oktopus.app.br. Na seção de Integrações, você encontrará a referência completa da API, construída usando os padrões OpenAPI. Isso facilita a compreensão dos endpoints disponíveis, formatos de solicitação e respostas esperadas, mesmo que você esteja apenas começando.

Explorando a API na prática

No vídeo, usamos o Postman para explorar a API do Oktopus. Se você já trabalha com APIs, o Postman parecerá familiar. Ele permite importar a especificação da API diretamente da documentação e navegar instantaneamente pelos endpoints, exemplos de solicitações e respostas.

Dito isso, o Postman é apenas uma opção. Qualquer ferramenta capaz de ler especificações OpenAPI pode ser usada, e a experiência será muito semelhante.

Autenticação e tokens de API

Para manter as integrações seguras, o Oktopus usa autenticação baseada em token. O processo começa com a criação de um usuário dedicado dentro da plataforma Oktopus. Este usuário é usado exclusivamente para acesso à API.

Você pode conceder a este usuário permissões totais ou criar uma função personalizada com acesso limitado, dependendo de suas necessidades. Isso torna possível seguir o princípio do privilégio mínimo e garantir que as integrações interajam apenas com as partes do sistema que realmente necessitam.

Uma vez criado o usuário, você se autentica e gera um token. Este token é então incluído em cada solicitação de API. Ao usar ferramentas como o Postman, o manuseio do token é amplamente automático, permitindo que você se concentre na criação e no teste de integrações, em vez de gerenciar detalhes de autenticação.

Trabalhando com dados de dispositivos reais

Após a autenticação, o próximo passo é interagir com dados reais da plataforma. No passo a passo, recuperamos a lista de CPEs gerenciados pelo Oktopus, selecionamos um dispositivo e solicitamos informações de Wi-Fi e do dispositivo.

Todos os dados são retornados em JSON usando uma estrutura consistente. Essa consistência é intencional e torna-se especialmente poderosa em ambientes com múltiplos fornecedores, onde dispositivos diferentes normalmente expõem modelos de dados diferentes.

Uma única API para todos os fornecedores, modelos e protocolos

Um dos maiores desafios para os ISPs é lidar com a diversidade de dispositivos. Diferentes fornecedores, diferentes modelos de dados como TR-181 e TR-098, e diferentes protocolos como TR-069 e TR-369 frequentemente exigem tratamentos distintos.

O Oktopus abstrai toda essa complexidade. No nível da API, os dados parecem iguais, independentemente do dispositivo ou protocolo por trás deles. Isso significa que suas integrações podem ser escritas uma única vez e aplicadas a toda a sua frota, sem casos especiais ou lógica específica para cada fornecedor.

Indo mais fundo com acesso de baixo nível

Embora as abstrações facilitem as integrações do dia a dia, há situações em que é necessário um controle mais profundo. Para casos de uso avançados, o Oktopus permite que você crie e envie mensagens brutas TR-069 ou TR-369 diretamente para a CPE.

Isso lhe dá a flexibilidade para criar diagnósticos personalizados, fluxos de trabalho de solução de problemas avançados ou automações altamente especializadas, tudo isso enquanto continua se beneficiando das abstrações de alto nível quando você não precisa desse nível de controle.

Projetado para crescimento e automação

A API REST do Oktopus foi criada para suportar operações simples e complexas. Você pode começar com integrações diretas e evoluir gradualmente para uma automação mais profunda à medida que sua operação amadurece.

Esteja você conectando seu sistema de faturamento, automatizando fluxos de trabalho de suporte ou criando ferramentas e painéis internos, a API oferece uma base estável e escalável.

Vamos conversar sobre o seu caso de uso

Se você tiver dúvidas sobre a integração com o Oktopus ou quiser discutir como a API pode dar suporte aos seus fluxos de trabalho específicos, teremos o prazer de conversar.

Explore a documentação, assista ao vídeo e sinta-se à vontade para entrar em contato. Estamos sempre interessados em entender casos de uso reais e ajudar as equipes a aproveitar ao máximo sua infraestrutura.

O Oktopus é um gerenciamento moderno de CPE criado para a automação no mundo real.

‍