Integração da API do Service Provider Connect

Este artigo explica como começar a integrar as APIs da Transatel para gerenciar seu serviço Service Provider Connect.
Resumiremos todas as APIs necessárias, com os links no Transatel Developer Portal e referências de API.
Consulte primeiro este artigo para conhecer nossas APIs.

A Transatel oferece muitas APIs, mas você pode começar com apenas alguns métodos.

Fatos-chave para entender o que é necessário:
– As eSIMs do Service Provider Connect são entregues a você no status Preactivado.
Portanto, você não precisa fazer nenhuma ativação ou alteração de status – apenas adicione o pacote correto e pronto!
– Os perfis eSIM já estão no status “released”, o que significa que estão prontos para serem baixados no dispositivo do usuário final.
Você só precisa fornecer o código QR/código de ativação – nenhuma ação adicional é necessária.

APIs obrigatórias:
– Autenticação
Use esta API para obter tokens de acesso.
Observe que as credenciais da API não são as mesmas que as credenciais do portal de gerenciamento de SIM.
O Client ID e o segredo serão fornecidos pelo seu gerente de conta.

– Assinatura OCS
Esta é a API principal necessária para o serviço.
Ela permitirá adicionar os pacotes corretos às suas SIMs.
Nota importante: você pode usar 2 tipos de OrderTypes: “preload” e “subscribe”.
Veja a seção detalhada abaixo sobre este assunto.

APIs recomendadas:
– SIM Management API
Neste conjunto de APIs, você só precisa e só pode usar “Get eSIM details”
Esta API permite que você:
* recupere o código de ativação, link de download do QR Code e status de uma eSIM
* recupere o status da eSIM no dispositivo – isso pode ajudar seu suporte no troubleshooting
As APIs para “Reservar” e “Liberar” perfis não se aplicam à oferta Service Provider Connect. Seus perfis já estão reservados e liberados.

– 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 pacotes por localização, incluímos as localizações cobertas em um pacote no campo “tags”, no formato ISO-2.

– OCS Events
Use esta API para receber eventos de Webhook relacionados ao ciclo de vida do produto (ex: pacote expirado…). Isso é útil para habilitar notificações para seus usuários finais.

APIs opcionais para implementar uma integração mais complexa:
– Subscription Management API
Como mencionado acima, os cartões SIM do Service Provider Connect são preativados. Portanto, você não é obrigado a integrar nossas APIs de Subscription Management para ativar os cartões SIM. Eles serão ativados automaticamente na primeira conexão à rede.
No entanto, você ainda pode integrá-las se:
– desejar Suspender ou Encerrar SIMs,
– quiser preencher campos de informação como Referência ou Grupos para organizar sua frota, pois essas dimensões podem ser encontradas em nosso portal de gerenciamento de SIMs.
Se desejar acesso às nossas APIs de Subscription Management, consulte seu gerente de conta para solicitar acesso, pois normalmente não abrimos por padrão para clientes Service Provider Connect.

Como a documentação da API é genérica e não lista valores específicos da oferta, aqui está tudo o 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_M2MA_COS_SPC

Pagamento: para o Service Provider Connect, como você – cliente da Transatel – está pagando os pacotes à 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 Subscription Management.
Você pode encontrar seu RatePlan na Plataforma de Gerenciamento de SIMs em Catálogo > Opções

Os cartões SIM e eSIMs do Service Provider Connect são entregues a você no status Preactivado. Eles serão ativados automaticamente na primeira conexão à rede. (O ciclo de vida dos SIMs do Service Provider Connect está detalhado aqui).

Com base no status da SIM, aqui está o OrderType recomendado para uso:
– Use OrderType “Preload” em SIMs Preactivados –> a SIM permanecerá preativada até ser instalada e usada pelo usuário final
– Use OrderType “Subscribe” em cartões SIM Ativos –> você não pode pré-carregar um plano em um SIM ativo.
Em ambos os casos, o plano de dados não começará até que a SIM esteja sendo usada em uma localização coberta pelo plano.


Você pode usar os exemplos fornecidos na referência da API OCS Products para encontrar payloads de requisições com os diferentes valores: