Configuração da API + Gestão Automatizada de Pedidos (AOM) + Relatórios Automatizados de Uso
Parte 0: Configuração
O WeTransact envia eventos para o Ponto de extremidade do tópico do Event Grid que você configura em Configurações no WeTransact Portal.
3.1 Acesso à API
Se você quiser controlar a ativação programaticamente, precisará de uma chave de API.
Para gerar uma chave:
- Acesse seu portal WeTransact: yourcompany.wetransact.io
- Acesse Configurações → Integrações → role até a seção Acesso à API
- Clique em Gerar
- Copie a chave imediatamente e armazene-a em um gerenciador de segredos

Parte 1: Gerenciamento Automatizado de Pedidos (AOM)
1. Introdução
📖 Referência da API: https://apidocs.wetransact.io/openapi/subscriptions
Quando os publicadores do Marketplace possuem um processo automatizado de provisionamento, a maioria deles gostaria de integrar o canal de compras do Marketplace a esse processo. Por meio da WeTransact Platform, isso pode ser alcançado seguindo este guia.
2. Processo de Pedido
Ao vender por meio do Microsoft Marketplace, a Microsoft determina o fluxo do pedido. Quando o AOM está habilitado, o WeTransact atua como middleware entre o Microsoft Marketplace e seu sistema de gerenciamento de pedidos.
Como funciona:
- O cliente faz uma compra → é redirecionado para a WeTransact Landing Page
- O comprador clica em Confirmar compra → pedido enviado para o WeTransact Portal
- O WeTransact envia um evento CreateSubscription para seu endpoint Event Grid
- Seu sistema provisiona e ativa a assinatura
- O WeTransact notifica o Microsoft Marketplace para confirmar a ativação

Eventos subsequentes do ciclo de vida — após a ativação, o WeTransact também encaminha estes:
Evento | Descrição |
|---|---|
Cancelamento | O cliente cancela; o serviço termina ao final do período de compromisso |
Suspensão | A Microsoft não conseguiu coletar o pagamento; considere suspender o serviço |
Restabelecimento | Pagamento coletado após suspensão; restabeleça o serviço |
Renovação | Assinatura renovada manualmente ou via renovação automática |
Alteração de plano | O cliente alterou o nível do plano (ex.: Basic → Standard) |
Alteração da quantidade de licenças | O cliente alterou o número de usuários (somente planos Per-User) |
3 Ativação de Assinatura
Os publicadores devem ativar uma assinatura dentro de 30 dias ou a Microsoft a cancelará automaticamente.
Há três maneiras de ativar:
Opção 1 — Manual (portal) Vá para Pedidos → clique em Tome uma atitude → aprove ou rejeite.

Opção 2 — Aprovação automática Vá para Listagem de produtos → Plano de preços → habilite Aprovar automaticamente novos pedidos (disponível para todos os planos ou para um plano específico).
Para todos os planos

Para um plano específico

Opção 3 — Via API (recomendado para AOM) Receba o evento CreateSubscription, conclua o provisionamento e depois chame a API para ativar.
3.2 Ativação via API
| |
|---|---|
Método | POST |
URL | https://[YOUR-SUBDOMAIN].wetransact.io/api/v1.0/subscriptions/[SUBSCRIPTION-ID]/actions/activate |
Cabeçalho | x-api-key: [YOUR API KEY] |
Respostas:
- 200 OK — processado com sucesso
- 500 — falha, entre em contato com o Suporte da WeTransact
4. Eventos e mensagens
4.1 CreateSubscription
Enviado quando uma assinatura é criada. Contém tudo o que é necessário para provisionamento e ativação.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID atribuído pela Microsoft. Use como seu identificador exclusivo. |
Created | DATETIME | Timestamp da criação da assinatura |
CompanyName | STRING | Nome da empresa compradora |
MarketplaceOfferId | STRING | ID do produto no Partner Center |
MarketplacePlanId | STRING | ID do plano (SKU) no Partner Center |
SeatQuantity | STRING (opcional) | Número de assentos — somente planos Per-User |
TermUnit | STRING | P1M / P1Y / P2Y / P3Y |
InitialUserEmail | STRING | Email do comprador |
AdditionalDetails | STRING (opcional) | Campos extras da Landing Page, como JSON |
Channel | STRING | Direto ou Indireto (CSP) |
BeneficiaryEmail | STRING (opcional) | Email do usuário final — difere do comprador quando via CSP |
json
4.2 CancelSubscription
Enviado quando um cliente cancela. O serviço permanece ativo até o fim do período contratado.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura cancelada |
json
4.3 SuspenderAssinatura
Enviado quando a Microsoft não consegue coletar o pagamento. Considere suspender o serviço ou entrar em contato com o cliente.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura suspensa |
json
4.4 RestabelecerAssinatura
Enviado quando a Microsoft coleta o pagamento após uma suspensão. Restabeleça o serviço se ele tiver sido suspenso.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura a ser restabelecida |
json
4.5 RenovarAssinatura
Enviado quando uma assinatura é renovada manualmente ou via renovação automática.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura renovada |
json
4.6 AlterarPlano
Enviado quando um cliente altera o nível do plano. Atualize feature flags, direitos ou alocações de recursos.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura afetada |
MarketplacePlanId | STRING | ID do novo plano (SKU) |
json
4.7 AlterarQuantidadeDeAssentos
Enviado quando um cliente altera a contagem de assentos. Apenas planos Per-User. Atualize as alocações de computação/recursos adequadamente.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura afetada |
SeatQuantity | STRING | Nova contagem total de assentos |
json
4.8 FalhaAoAtivarAssinatura
Enviado quando a ativação falha downstream após uma chamada de API retornar 200 OK. Entre em contato com o Suporte da WeTransact imediatamente.
Campo | Tipo | Descrição |
|---|---|---|
MarketplaceSubscriptionId | GUID | ID da assinatura que falhou ao ativar |
json
5. Roteamento de Mensagens
Todas as mensagens incluem um campo Subject para filtragem na sua assinatura do Event Grid:
Assunto | Gatilho |
|---|---|
CreateSubscription | Novo pedido realizado |
CancelSubscription | Cliente cancelou |
SuspendSubscription | Falha no pagamento |
ReinstateSubscription | Pagamento resolvido |
RenewSubscription | Assinatura renovada |
ChangePlan | Nível do plano alterado |
ChangeSeatQuantity | Contagem de assentos alterada |
ActivateSubscriptionFailed | Falha de ativação downstream |
Parte 2: Relatório Automatizado de Uso
Introdução
📖 Referência da API: https://apidocs.wetransact.io/openapi/subscriptions
Alguns publicadores do Marketplace precisam reportar o uso por meio de uma API. Isso é necessário quando a frequência de relatório é alta (mais de uma vez por mês). Esta seção explica como a API WeTransact é usada para reportar uso.
O relatório de uso sempre precisa ocorrer em relação a uma assinatura ativa, que é identificável de forma exclusiva por um GUID. Quando esse GUID é obtido, o publicador pode reportar uso definindo os valores por medidor. Toda a documentação da API está disponível em:
https://apidocs.wetransact.io/openapi
Esta especificação da API descreve todos os outros detalhes relacionados à API, incluindo exemplos de mensagens de solicitação e resposta. A seção 7.1 explica como obter acesso à API WeTransact.
Na etapa 1 o sistema de relatórios do publicador obtém o ID correto da assinatura (nome exato do campo: marketplaceSubscriptionId) primeiro obtendo todas as assinaturas por meio do endpoint GET /subscriptions. Para incluir informações sobre medidores válidos para a assinatura, o parâmetro de consulta includeMeters=true deve ser adicionado. Se o ID da assinatura e os detalhes do medidor já estiverem armazenados, esta etapa pode ser ignorada.
Na etapa 2, o sistema do lado do publicador precisa fazer uma cobrança em relação ao ID da assinatura. Isso é feito chamando o endpoint POST /subscriptions/{id}/charge. Aqui, o sistema define o ID da assinatura a ser cobrada, bem como o ID do medidor e o valor. A plataforma WeTransact cuida da troca de mensagens com o Microsoft Marketplace (etapa 3).
7.1 Acesso à API
Quando os publicadores desejam automatizar o relatório de uso, é necessário acesso à API. Se nenhuma chave de API tiver sido criada, a seção Settings mostrará um botão Generate.