Embedding

Updated: February 15, 2021
Contents

Overview

  • Background: Embedding attributes are part of the Product definition
  • Versioned: Yes (see versions)
  • Localized: Yes (see locales)

The Embedding section from the product profile page enables Vendors to customize self-service embedding experience of the customers and resellers (in case your product supports tier configuration).

The following describes each tab and every option within the Embedding section.

General

The General tab provides general embedding customization settings, such as a product description, getting started text, download links, and documentation links.

Presentation

Description: Enter your product description. The description text has to be less than 256 characters long.

Getting Started: Provide your getting started material. This field supports up to 4096 characters.

Download Links

Specify static download links required for your customers:

  • Title: Type your download link title.
  • URL: Enter your download link.

Documentation Links

Specify static links to your documentation:

  • Title: Type your documentation title.
  • URL: Enter your documentation link.

Templates

Access the Embedding tab to customize messages that will be shown to users during various states. This includes a pending template, inquiring templates, and subscription approved templates.

Pending Template

Customize a “pending” state message by editing this template. This message will be displayed to users that ordered a product and initiated a fulfillment request.

Inquiring Template

Customize an “inquiring” state message with this template. This message will be displayed to users that are required to provide necessary information or fill out an activation form.

Subscription Approved Template

Customize a “subscription approved” message with this template. This message will be displayed to users in case their fulfillment requests are approved and completed.

Actions

The Actions tab enables Vendors to customize an actions list, their endpoint URL, and their JWT secret.

Actions list

The Actions list displays your customized buttons on the customer embedding service service screen. Follow the steps below to successfully create a new action button.

1. Click Create Action to create a new action button.

2. Fill out the following form:

  • ID: Enter a unique identifier for this action button.
  • Title: Type a title for your action button.
  • Description: Enter a short action button description in this field.
  • Scope: Select a scope for your action button.

Information

Tier 1 and Tier 2 scopes available only with the enabled Reseller Authorization capability from the Capabilities section.

3. Click Create to finalize your action button creation.

Thus, your action button will be successfully created and it will be displayed on the Actions list.

Endpoint URL

Use this setting to customize redirect URL of this product API.

Click on the Edit icon to edit your endpoint URL.

JWT secret

Use this setting to view or generate your JSON Web Token secret.

Click on the Show Secret icon to display a JWT secret.
Click on the Refresh icon to generate a new JWT secret.

Is this page helpful?
Translate with Google
Copied to clipboard