Skip to content

WeTransact Platform API (1.0)

API for managing subscriptions and metering for WeTransact Publishers.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Support Team

support@wetransact.io

Languages
Servers
WeTransact Publisher API Base URL

https://<yoursubdomain>.wetransact.io/api/v1/

Subscriptions

All functions that relate to the subscription entity in the WeTransact Platform.

Operations

Products

All product operations on the WeTransact Platform

Operations

List products

Request

Security
api_key
curl -i -X GET \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of products

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  {
    "productId": "c82329c5-5331-4580-96af-2d2cb6aebde9",
    "productName": "WeTransact",
    "status": "Published",
    "created": "2024-02-13T13:35:56",
    "productDescription": "<p>Introducing <a href=\"https://www.wetransact.io/\">WeTransact</a>...</p>",
    "gettingStartedInstructions": "Getting Started Instructions",
    "searchKeyword1": "Marketplace Publishing",
    "searchKeyword2": "Integration",
    "searchKeyword3": "Go-to-Market",
    "logoUrl": "https://xyz.blob.core.windows.net/productlogos/logo.png",
    "screenshots": [ … ],
    "supportingFiles": [ … ],
    "videos": [ … ],
    "tagLine": "Publish and Sell on Azure Marketplace with ease!",
    "privacyPolicyUrl": "https://www.wetransact.io/privacy",
    "supportUrl": "https://www.wetransact.io/support",
    "termsAndConditionsAmendmentText": null,
    "termsAndConditionsType": "msftcontract",
    "termsAndConditionsLink": null,
    "partnerCenterOfferId": "c82329c5-5331-4580-96af-2c2cb6aebab9",
    "hasUnpublishedDetails": true,
    "productType": "SaaS",
    "selectedPublisher": "EMEA",
    "plans": [ … ],
    "subscriptionIds": [ … ],
    "isFullyHostedInAzure": true,
    "links": [ … ]
  }
]

Get product by ID

Request

Security
api_key
Path
productIdstring(uuid)required
curl -i -X GET \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The requested product

Bodyapplication/json
object
Response
application/json
{
  "productId": "c82329c5-5331-4580-96af-2d2cb6aebde9",
  "productName": "WeTransact",
  "status": "Published",
  "created": "2024-02-13T13:35:56",
  "productDescription": "<p>Introducing <a href=\"https://www.wetransact.io/\">WeTransact</a>...</p>",
  "gettingStartedInstructions": "Getting Started Instructions",
  "searchKeyword1": "Marketplace Publishing",
  "searchKeyword2": "Integration",
  "searchKeyword3": "Go-to-Market",
  "logoUrl": "https://xyz.blob.core.windows.net/productlogos/logo.png",
  "screenshots": [
    "https://xyz.blob.core.windows.net/files/screenshot.png"
  ],
  "supportingFiles": [
    { … }
  ],
  "videos": [
    "https://www.youtube.com/watch?v=xyz"
  ],
  "tagLine": "Publish and Sell on Azure Marketplace with ease!",
  "privacyPolicyUrl": "https://www.wetransact.io/privacy",
  "supportUrl": "https://www.wetransact.io/support",
  "termsAndConditionsAmendmentText": null,
  "termsAndConditionsType": "msftcontract",
  "termsAndConditionsLink": null,
  "partnerCenterOfferId": "c82329c5-5331-4580-96af-2c2cb6aebab9",
  "hasUnpublishedDetails": true,
  "productType": "SaaS",
  "selectedPublisher": "EMEA",
  "plans": [
    { … }
  ],
  "subscriptionIds": [
    "343ebc84-7a85-45fc-8fce-82ca0b358784"
  ],
  "isFullyHostedInAzure": true,
  "links": [
    { … }
  ]
}

Get product by partner center offer ID

Request

Security
api_key
Path
partnerCenterOfferIdstringrequired
curl -i -X GET \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The requested product

Bodyapplication/json
object
Response
application/json
{
  "productId": "c82329c5-5331-4580-96af-2d2cb6aebde9",
  "productName": "WeTransact",
  "status": "Published",
  "created": "2024-02-13T13:35:56",
  "productDescription": "<p>Introducing <a href=\"https://www.wetransact.io/\">WeTransact</a>...</p>",
  "gettingStartedInstructions": "Getting Started Instructions",
  "searchKeyword1": "Marketplace Publishing",
  "searchKeyword2": "Integration",
  "searchKeyword3": "Go-to-Market",
  "logoUrl": "https://xyz.blob.core.windows.net/productlogos/logo.png",
  "screenshots": [
    "https://xyz.blob.core.windows.net/files/screenshot.png"
  ],
  "supportingFiles": [
    { … }
  ],
  "videos": [
    "https://www.youtube.com/watch?v=xyz"
  ],
  "tagLine": "Publish and Sell on Azure Marketplace with ease!",
  "privacyPolicyUrl": "https://www.wetransact.io/privacy",
  "supportUrl": "https://www.wetransact.io/support",
  "termsAndConditionsAmendmentText": null,
  "termsAndConditionsType": "msftcontract",
  "termsAndConditionsLink": null,
  "partnerCenterOfferId": "c82329c5-5331-4580-96af-2c2cb6aebab9",
  "hasUnpublishedDetails": true,
  "productType": "SaaS",
  "selectedPublisher": "EMEA",
  "plans": [
    { … }
  ],
  "subscriptionIds": [
    "343ebc84-7a85-45fc-8fce-82ca0b358784"
  ],
  "isFullyHostedInAzure": true,
  "links": [
    { … }
  ]
}