---
title: Configuración de API + Gestión automatizada de pedidos (AOM) + Informes automatizados de uso
slug: es/configuracion-de-api-gestion-automatizada-de-pedidos-aom-informes-automatizados-de-uso
icon: {"faIcon":"fa-brands fa-wordpress"}
createdAt: 2026-03-10T18:19:01.825Z
---

# Parte 0: Configuración

WeTransact envía eventos al **Punto de conexión del tema de Event Grid** que configure en **Configuración** en el portal de WeTransact.

### 3.1 Acceso a API

:::BlockQuote
📖 Referencia de API: https\://apidocs.wetransact.io/openapi/subscriptions
:::

Si desea controlar la activación mediante programación, necesita una clave de API.

**Para generar una clave:**

1. Vaya a su portal de WeTransact: yourcompany.wetransact.io
2. Vaya a **Configuración** → **Integraciones&#x20;**→ desplácese hasta la sección **Acceso a la API**
3. Haga clic en **Generar**
4. Copie la clave inmediatamente y almacénela en un administrador de secretos

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/2N4POKUZ-0O8BJSNQvqtP_fig4-api-key-created.png)

:::BlockQuote
⚠️ **La clave solo es visible una vez.** Después de salir de la página no se mostrará nuevamente. Si se ve comprometida, genere una nueva para invalidar la clave anterior
:::

# <font color="#4338CA">Parte 1\: Gestión automatizada de pedidos (AOM)</font>

## 1. Introducción

📖 Referencia de API: https\://apidocs.wetransact.io/openapi/subscriptions

Cuando los publicadores de Marketplace tienen un proceso de aprovisionamiento automatizado, la mayoría desea integrar el canal de compra de Marketplace con ese proceso. A través de la plataforma WeTransact, esto puede lograrse siguiendo esta guía.

## 2. Proceso de pedido

Al vender a través de Microsoft Marketplace, Microsoft dicta el flujo de pedidos. Cuando AOM está habilitado, WeTransact actúa como middleware entre Microsoft Marketplace y su sistema de gestión de pedidos.

**Cómo funciona:**

1. El cliente realiza una compra → es redirigido a la WeTransact Landing Page
2. El comprador hace clic en **Confirmar compra** → el pedido se envía al portal de WeTransact
3. WeTransact envía un evento CreateSubscription a su endpoint de Event Grid
4. Su sistema aprovisiona y activa la suscripción
5. WeTransact notifica a Microsoft Marketplace para confirmar la activación

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/fBzcvZrJQXXciFY4G1O9u_fig1-order-flow.png)

**Eventos posteriores del ciclo de vida** — después de la activación, WeTransact también reenvía estos:

| Evento                             | Descripción                                                                   |
| ---------------------------------- | ----------------------------------------------------------------------------- |
| Cancelación                        | El cliente cancela; el servicio finaliza al término del período de compromiso |
| Suspensión                         | Microsoft no pudo cobrar el pago; considere suspender el servicio             |
| Restablecimiento                   | Pago cobrado después de la suspensión; restablezca el servicio                |
| Renovación                         | Suscripción renovada manualmente o mediante renovación automática             |
| Cambio de plan                     | El cliente cambió el nivel del plan (p. ej., Basic → Standard)                |
| Cambio en la cantidad de licencias | El cliente cambió el número de usuarios (solo planes Per-User)                |

##

### 3 Activación de suscripción

Los publicadores deben activar una suscripción **dentro de los 30 días** o Microsoft la cancelará automáticamente.

:::BlockQuote
🚨 **Ventana de 30 días.** Configure monitoreo y alertas en su cola de pedidos para evitar perder este plazo.
:::

Hay tres formas de activar:

**Opción 1 — Manual (portal)** Vaya a **Pedidos** → haga clic en **Actúa** → apruebe o rechace.

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/DJKA9SwNjidNaZTqNGKNu_fig5-manual-activation.png)

**Opción 2 — Aprobación automática** Vaya a **Listado de productos → Plan de precios** → habilite **Aprobar automáticamente los nuevos pedidos** (disponible para todos los planes o para un plan específico).

Para todos los planes

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/j6bnG7ZRhf8FZrsaVWxso_image.png)

Para un plan específico

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/GZAvJSjulWzSK7JD4mrgP_image.png)

**Opción 3 — Vía API** *(recomendado para AOM)* Reciba el evento CreateSubscription, complete el aprovisionamiento y luego llame a la API para activar.

### 3.2 Activación vía API

| &#x20;         |                                                                                                     |
| -------------- | --------------------------------------------------------------------------------------------------- |
| **Método**     | POST                                                                                                |
| **URL**        | https\://\[YOUR-SUBDOMAIN].wetransact.io/api/v1.0/subscriptions/\[SUBSCRIPTION-ID]/actions/activate |
| **Encabezado** | x-api-key: \[YOUR API KEY]                                                                          |

**Respuestas:**

- 200 OK — procesado correctamente
- 500 — falló, contacte al soporte de WeTransact

:::BlockQuote
ℹ️ Un 200 no garantiza la activación. Si falla en un proceso posterior, WeTransact enviará un evento ActivateSubscriptionFailed de forma asíncrona. Contacte al soporte si esto sucede.
:::

## 4. Eventos y mensajes

### 4.1 CreateSubscription

Se envía cuando se crea una suscripción. Contiene todo lo necesario para el aprovisionamiento y la activación.

| Campo                     | Tipo                | Descripción                                                                         |
| ------------------------- | ------------------- | ----------------------------------------------------------------------------------- |
| MarketplaceSubscriptionId | GUID                | ID asignado por Microsoft. Úselo como su identificador único.                       |
| Created                   | DATETIME            | Marca de tiempo de creación de la suscripción                                       |
| CompanyName               | STRING              | Nombre de la empresa compradora                                                     |
| MarketplaceOfferId        | STRING              | ID del producto en Partner Center                                                   |
| MarketplacePlanId         | STRING              | ID del plan (SKU) en Partner Center                                                 |
| SeatQuantity              | STRING *(opcional)* | Número de puestos — solo planes Per-User                                            |
| TermUnit                  | STRING              | P1M / P1Y / P2Y / P3Y                                                               |
| InitialUserEmail          | STRING              | Correo electrónico del comprador                                                    |
| AdditionalDetails         | STRING *(opcional)* | Campos adicionales de Landing Page, como JSON                                       |
| Channel                   | STRING              | Directo o indirecto (CSP)                                                           |
| BeneficiaryEmail          | STRING *(opcional)* | Correo electrónico del usuario final — difiere del comprador cuando es mediante CSP |

json

:::BlockQuote
\{  "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0",  "Created": "2025-03-07T12:34:56.7892",  "CompanyName": "EndCustomer",  "MarketplaceOfferId": "offer-123",  "MarketplacePlanId": "plan-premium",  "SeatQuantity": "10",  "TermUnit": "P1Y",  "InitialUserEmail": "purchasing\@contoso.com",  "AdditionalDetails": "\{}",  "Channel": "Indirect",  "BeneficiaryEmail": "user\@endcustomer.io",  "ResellerName": "Contoso"}
:::

### 4.2 CancelSubscription

Se envía cuando un cliente cancela. El servicio permanece activo hasta el final del plazo comprometido.

| Campo                     | Tipo | Descripción                    |
| ------------------------- | ---- | ------------------------------ |
| MarketplaceSubscriptionId | GUID | ID de la suscripción cancelada |

json

:::BlockQuote
\{ "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0" }
:::

### 4.3 SuspendSubscription

Enviado cuando Microsoft no puede cobrar el pago. Considere suspender el servicio o contactar al cliente.

| Campo                     | Tipo | Descripción                     |
| ------------------------- | ---- | ------------------------------- |
| MarketplaceSubscriptionId | GUID | ID de la suscripción suspendida |

json

:::BlockQuote
\{ "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0" }
:::

### 4.4 ReinstateSubscription

Enviado cuando Microsoft cobra el pago después de una suspensión. Restablezca el servicio si fue suspendido.

| Campo                     | Tipo | Descripción                                  |
| ------------------------- | ---- | -------------------------------------------- |
| MarketplaceSubscriptionId | GUID | ID de la suscripción que se debe restablecer |

json

:::BlockQuote
\{ "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0" }
:::

### 4.5 RenewSubscription

Enviado cuando una suscripción se renueva manualmente o mediante renovación automática.

| Campo                     | Tipo | Descripción                   |
| ------------------------- | ---- | ----------------------------- |
| MarketplaceSubscriptionId | GUID | ID de la suscripción renovada |

json

:::BlockQuote
\{ "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0" }
:::

### 4.6 ChangePlan

Enviado cuando un cliente cambia el nivel del plan. Actualice los indicadores de funciones, los derechos o las asignaciones de recursos.

| Campo                     | Tipo   | Descripción                   |
| ------------------------- | ------ | ----------------------------- |
| MarketplaceSubscriptionId | GUID   | ID de la suscripción afectada |
| MarketplacePlanId         | STRING | ID del nuevo plan (SKU)       |

json

:::BlockQuote
\{  "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0",  "MarketplacePlanId": "plan-premium"}
:::

### 4.7 CambiarCantidadDeAsientos

Se envía cuando un cliente cambia la cantidad de asientos. Solo para planes Per-User. Actualice las asignaciones de cómputo/recursos según corresponda.

| Campo                     | Tipo   | Descripción                      |
| ------------------------- | ------ | -------------------------------- |
| MarketplaceSubscriptionId | GUID   | ID de la suscripción afectada    |
| SeatQuantity              | STRING | Nueva cantidad total de asientos |

json

:::BlockQuote
\{  "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0",  "SeatQuantity": "150"}
:::

### 4.8 ActivarSuscripciónFallida

Se envía cuando la activación falla en procesos posteriores después de que una llamada API devolvió 200 OK. Contacte al soporte de WeTransact inmediatamente.

| Campo                     | Tipo | Descripción                                |
| ------------------------- | ---- | ------------------------------------------ |
| MarketplaceSubscriptionId | GUID | ID de la suscripción cuya activación falló |

json

:::BlockQuote
\{ "MarketplaceSubscriptionId": "a1fabe21-7904-4c2f-932d-5253a35e97d0" }
:::

## 5. Enrutamiento de mensajes

Todos los mensajes incluyen un campo Subject para filtrar en su suscripción de Event Grid:

| Subject                    | Desencadenador                              |
| -------------------------- | ------------------------------------------- |
| CreateSubscription         | Nuevo pedido realizado                      |
| CancelSubscription         | Cliente canceló                             |
| SuspendSubscription        | Fallo de pago                               |
| ReinstateSubscription      | Pago resuelto                               |
| RenewSubscription          | Suscripción renovada                        |
| ChangePlan                 | Nivel del plan cambiado                     |
| ChangeSeatQuantity         | Cantidad de asientos cambiada               |
| ActivateSubscriptionFailed | La activación falló en procesos posteriores |

# <font color="#1300fffb">Parte 2\: Informes automatizados de uso</font>

## Introducción

📖 Referencia de API: https\://apidocs.wetransact.io/openapi/subscriptions

Algunos publicadores de Marketplace necesitan informar el uso mediante una API. Esto es necesario cuando la frecuencia de los informes es alta (más de una vez al mes). Esta sección explica cómo se utiliza la API de WeTransact para informar el uso.

El informe de uso siempre debe realizarse sobre una suscripción activa, que se identifica de forma única mediante un GUID. Cuando se obtiene ese GUID, el publicador puede informar el uso definiendo las cantidades por medidor. Toda la documentación de la API está disponible en:&#x20;

https\://apidocs.wetransact.io/openapi

Esta especificación de API describe todos los demás detalles relacionados con la API, incluidos mensajes de solicitud y respuesta de ejemplo. La sección 7.1 explica cómo obtener acceso a la API de WeTransact.

![](https://api.archbee.com/api/optimize/wlBoYP3-_D88k8I6lqBSW/5SLXHR6Fv0okpak6-Blh4_.blob)

En el **paso 1** el sistema de informes del publicador obtiene el ID de suscripción correcto (nombre exacto del campo: marketplaceSubscriptionId) obteniendo primero todas las suscripciones mediante el endpoint GET /subscriptions. Para incluir información sobre los medidores válidos para la suscripción, se debe agregar el parámetro de consulta includeMeters=true. Si el ID de suscripción y los detalles del medidor ya están almacenados, este paso puede omitirse.

En el **paso 2**, el sistema del lado del publicador debe realizar un cargo contra el ID de suscripción. Esto se hace llamando al endpoint POST /subscriptions/&#x7B;id}/charge. Aquí el sistema define el ID de suscripción sobre el cual realizar el cargo, así como el ID del medidor y la cantidad. La plataforma WeTransact se encarga del intercambio de mensajes con Microsoft Marketplace (**paso 3**).

### 7.1 Acceso a la API

Cuando los publicadores desean automatizar los informes de uso, se necesita acceso a la API. Si no se ha creado ninguna clave API, la sección Settings mostrará un botón Generate.
