Skip to main content
In Platform Settings, Merchants can manage integration options and platform configurations. Merchants can:
  • Create API keys
  • Configure SFTP settings
  • Add a health check endpoint.
For the Platform-managed product lifecycle, Merchants can also:
  • Subscribe to webhook events
  • Add redemption URLs
  • Inform Partner Ecosystem Management if they’d like to generate redemption codes for customers. Note: If the Merchant chooses to have Partner Ecosystem Management generate redemption codes for customers, the Merchant can set the expiration time for the redemption codes in Platform Settings.

​
API Keys

API keys allow Merchants to connect to the Partner Ecosystem Management APIs and manage the services from their agreements with Resellers. Partner Ecosystem Management allows Merchants to generate an API key for each Reseller (Service Provider) they have a partnership with. After authenticating with the API key, a Merchant can communicate on the back end with the connected Reseller via Partner Ecosystem Management. Merchants can manage entitlements and subscription transactions for products that are associated with active agreements. Merchants can generate API keys in Platform Settings.

​
SFTP Settings

Configuring SFTP settings generates SFTP credentials for the Merchant and sets up a SFTP location where reports (including the Reconciliation report) can be generated. After connecting with their credentials via a SFTP program, Merchants can register for reports and download reports via SFTP or the UI. SFTP settings configuration is also required before registering for the Reconciliation process.

​
Health Check Endpoints

Health check endpoints allow Partner Ecosystem Management Operations to monitor the health of Merchants’ integration and troubleshoot any incidents if they arise. After the Merchant provides a health check endpoint, the Platform Health Status page shows the status of partnered organizations’ integrations with ​Partner Ecosystem Management​ as well as the general status of Partner Ecosystem Management.

​
Webhooks

Partner Ecosystem Management allows Merchants with Platform-Managed products to subscribe to Partner Ecosystem Management webhooks in the Platform Settings space. A webhook, or a web callback, is a way for Partner Ecosystem Management to provide Merchants with real-time information about Partner subscription provisioning and fulfillment events. Possible events include creating, updating, and deleting Partner subscriptions. Webhooks can be more efficient than polling for updates. To get data, all Merchants need to do is subscribe to the webhook. After the configuration, Partner Ecosystem Management sends the events to the endpoint URL. Merchants get updates as they happen. Merchants can subscribe to the following events:

​
Redemption URLs and Redemption Codes for Product Provisioning

Merchants can set up redemption URLs, which allow customers to activate Platform-managed products that have been provisioned to them. Merchants can set up redemption URLs in Platform Settings > Activation. When a customer receives a redemption URL, they also need to receive and enter a redemption code to activate their subscription. Merchants can choose whether to provide redemption codes for the customer or have Partner Ecosystem Management automatically generate them. Merchants can turn this setting on or off using the Merchant will provide the redemption code for activation toggle. This toggle is off by default, meaning Partner Ecosystem Management generates all redemption codes for customers. When the toggle is turned on, the Merchant is responsible for generating redemption codes for customers during the activation flow. Redemption codes can optionally be included with the redemption URLs that Partner Ecosystem Management sends to customers. This gives customers a more seamless experience. If the Merchant wants Partner Ecosystem Management to generate the redemption code and send the code along with the redemption URL, the Merchant needs to do the following: include “@xxx@” in the redemption URL when creating it. For example: https://www.example.com/@xxx@/activate. If the Merchant will provide the redemption code for activation setting is off, the Merchant can configure the expiration time for redemption codes for Platform-managed products. The expiration time can be set in minutes. If the expiration time isn’t set, redemption codes for Platform-managed products won’t expire. Parent topic:Platform Settings