Integração da API Ubigi for Business

Introdução

Este artigo explica como começar a integrar as APIs da Transatel para gerenciar sua oferta Ubigi for Business.
Resumiremos todas as APIs obrigatórias e recomendadas, com os links no Transatel Developer Portal e referências de API.
Para iniciar a integração das nossas APIs, leia este artigo primeiro.
Ele explicará como obter as credenciais e onde encontrar os valores técnicos relacionados à sua oferta no SIM Management Portal.
Agora vamos aos detalhes sobre as APIs necessárias para gerenciar nossa oferta Ubigi for Business.

Ativando suas SIMs

O ciclo de vida e as informações das SIMs são gerenciados com a Connectivity Management API
Essas APIs são usadas para:
– ativar SIMs,
– modificar serviços (chamados de “opções”) para suas SIMs,
– suspender ou encerrar SIMs,
– preencher campos de informação como Referência ou Grupos para organizar sua frota
– recuperar as informações dos serviços de uma SIM específica

Para ativar suas SIMs Ubigi for Business, você encontrará todos os rótulos técnicos necessários no SIM Management Portal, em Catálogo > Opções.

Você precisará de:

• O plano tarifário usado para sua conta
  Se sua conta estiver no plano padrão em Euros, esta referência deve ser
  M2MA_WW_TSL_MWC_1
• Os rótulos técnicos para as opções que deseja configurar nas novas SIMs.
  Isso inclui escolher entre pay-per-use e bundles.
  Por exemplo, para ativar uma SIM no modelo de preços por bundles, você precisará selecionar UBGBUS_REF_BUNDLE na chamada da API.

Aqui está um exemplo de chamada de ativação para uma SIM que estará no modelo de preços por Bundles:

Para manter sua interface sincronizada, você pode querer receber os webhooks relacionados ao ciclo de vida da SIM.
Como muitas ações são assíncronas (ex: leva alguns minutos para ativar uma SIM após a chamada de ativação ser enviada), você pode querer receber eventos para saber quando uma alteração foi concluída.
Os webhooks que você pode receber estão detalhados aqui.

Adicionando e gerenciando bundles

Para gerenciar completamente os bundles, você precisará das seguintes APIs:

– OCS Subscription
Esta é a API principal necessária para o serviço.
Ela permitirá adicionar os bundles corretos às suas SIMs.

– OCS Inventory
Esta API permite verificar o inventário de uma SIM e o saldo restante. Use esta API para exibir o saldo restante de um plano em seu próprio app ou interface.

– OCS Catalog
Esta API permite recuperar todos os produtos disponíveis em nosso catálogo.
Dica: para verificar bundles por localização, incluímos as localizações cobertas em um bundle no campo “tags”, no formato ISO-2.

– OCS Events
Estes são os eventos de Webhook relacionados ao ciclo de vida do produto (ex: bundle expirado…). Isso é útil para habilitar notificações para seus usuários finais ou em sua própria interface.

Recuperando detalhes da eSIM

Para recuperar o código de ativação ou QR Code de uma eSIM, use a SIM Management API
Neste conjunto de APIs, você só precisa e só pode usar “Get eSIM details”
Esta API permite:
* recuperar o Código de Ativação, link de download do QR Code e status de uma eSIM
* recuperar o status da eSIM no dispositivo – isso pode ajudar seu suporte no troubleshooting
As APIs para “Reservar” e “Liberar” perfis não se aplicam à Ubigi for Business. Seus perfis já estão reservados e liberados.

Valores específicos de API para Ubigi for Business

Como a documentação da API é genérica e não lista valores específicos da oferta, aqui está tudo que você precisa saber:

mvnoRef: o nome da sua conta SPC, e começa com “M2MA_WW_TSL_…..”
Você pode encontrá-lo facilmente em nossa Plataforma de Gerenciamento de SIMs:


COS: refere-se ao catálogo da oferta.
– o valor para contas de produção é WW_COS_UBG_MKP_EUR

Pagamento: Como você – cliente da Transatel – está pagando os bundles à Transatel, o valor a inserir nas solicitações de assinatura é “Customer“

RatePlan
Este é um valor necessário apenas se você planeja usar a API opcional de Subscriptions Management.
Você pode encontrar seu RatePlan na Plataforma de Gerenciamento de SIMs em Catálogo > Opções