Applications Onboarding Instructions

1.Applications Onboarding #

In this section you will learn how to start the onboarding process of your application on the Cloudesire marketplace. Please note that the process is different for Deployed and Syndicated applications, therefore you need to know how your application works to upload it successfully.

TIPS:
In order to see your product visible on the marketplace, it should at least have one Plan set to published.

Applications Onboarding on Cloudesire: what you need

Software vendors can expose applications into the Cloudesire Applications Catalog This process is what we call Application Onboarding.

To upload a product you will need to choose one of the following methods:

  • ZIP Application Package: a simple archive containing both the source code and the SQL scripts of the application;
  • Docker image: a self-contained archive of your application meeting the Docker standards.
  • Syndication: integration via API for multi-tenant applications hosted elsewhere.

How to start the onboarding process

To start the onboarding process, go to the marketplace  select “log-in” at the top right corner of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. Select “Catalog” from the left menu, then select “Products” and click on the “Create New Product” button at the upper right hand corner.

Vendors Control Panel - new product onboarding

You will see a pop-up in which you can  insert your product name and choose between two onboarding options:

2.Applications Catalog (Marketing & Sales Onboarding) #

In this section you will understand how to add your application to your own catalog, complete the product description, select the right pricing model and, of course, upload it to the Cloudesire marketplace.

Understand the Catalog

The Catalog contains all the applications owned by the vendor. In this section you can see both applications that are available on the Cloudesire Marketplace and applications that are still not published.

To access the catalog, go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Catalog” from the menu on the left.

Vendors Control Panel: Edit Product page

Catalog Elements & Instructions for Completing the Product Description

The following picture shows the structure of a product in the Catalog section.

Vendor Dashboard - Catalog

Please note that you can save your project by clicking on “Save Product” on the top right at any time: this means that you can exit the platform and edit your product later. Please remember that if you edit an application that is already published on the marketplace and select “Save Product” changes will be live. This is one of the reasons why we recommend to upload and test changes on our Staging Marketplace (more info on the Staging Marketplace, click here.)

The following information are required for each product in the catalog:

General Information

  • Product Logohigh-resolution logo with fully transparent background.
  • Product Nameyour application name. It’s the name that will be associated with your product on the marketplace.
  • Category (e.g. CMS, CRM, etc.): this will help customers to understand your product category and will be shown on your product page on the marketplace.
  • Destination (B2B or B2C):  this will help customers to better understand your product and will be shown on your product page on the marketplace.
  • Tags (keyword list): these tags will help customers to quickly understand your product. Please, try to add only relevant tags to avoid too many tags on the product page.
  • Long and Short Description (text): they will describe your product to customers. Please try to be as relevant as possible: we suggest to keep the short description really short and explain the product in depth in the long description. You will have extra sections to add benefits, features, details of the product versions, terms and conditions and privacy policy, so please try to focus only on your product and your ideal target. We recommend to add the reasons why a customer should choose your product and the value proposition of your solution. We suggest to avoid extra-long descriptions: bullets can be very useful to avoid long paragraphs. This is the first thing customers will read about your product, so please make sure it is clear, catchy and without typos. Also, if your application is available in Italian and English, don’t forget to add the long and short description in both languages. You can switch language with the flag on the right of “Short description” and “Long description”.

Plus, you will find some extra fields:

  • SKU: your product ID. It is already pre-filled and you cannot change it.
  • Type: this field will be different according to your previous choice. If you chose “Deployed Product” the field will be “Managed” and you will have to upload your product ZIP application package or Docker image in the following field. If you chose “Syndicated Product” you will need to enter the syndication endpoint in the following field.

End-User Information

  • End-user instructions: in this field you can add optional information that can be provided to the customer to help him during the first access to the newly purchased application. Examples are default login and password or video  tutorials. Users will see these instructions in the dashboard. If your application is available in Italian and English, don’t forget to add the long and end-user information in both languages. You can switch language with the flag on the top right.
  • Features and benefits (ordered list): you can add features and benefits of your application, one at a time. Please try to be clear and relevant: customers will see this list as it is. We suggest to insert 3 or 6 features and benefits and avoid long lists. If your application is available in Italian and English, do not forget to add the long and short description in both languages. You can switch language with the flag on the right.
  • FAQ (ordered list of Questions and Answers): you can add some relevant FAQs about your product. Remember to add questions that can be relevant to help customers to choose your product, not only troubleshooting questions. If your application is available in Italian and English, don’t forget to add the long and short description in both languages. You can switch language with the flag on the right.

Visuals

  • External Video URLyour YouTube video will be shown on the product page, so avoid videos that are only tutorials or videos that are really long. A short and effective video on your product is a good choice.
  • Cover: this picture will  be used in the Marketplace slider, if the product is marked as “featured”. Please add a high-resolution image.
  • Screenshots (list of images): these images will be shown to customers, so please upload high-resolution pictures. Remember that is the first time that potential customer will see your application: we suggest to upload the main sections of your application or a demo of the product and avoid every single screen, if that’s not useful. 

T&C

  • Terms of Service: users will be able to read the terms of service of your application. Please insert a text and not a link.
  • Service Level Agreement: users will be able to read the service level agreement of your application. Please insert a text and not a link.
  • Privacy Policy: users will be able to read the privacy policy of your application. Please insert a text and not a link.

Custom metrics

  • Application Metric (AKA Custom Metrics) represents facts of a specific application offered in the Cloudesire Marketplace that are relevants for software vendors. To better understand custom metrics and how to add custom metrics to your application, please read this section.

Configuration Parameters

  • a list of parameters that have to be filled by customers before using the application for the first time, either for the application to work properly or to provide better initial customization (more details here). Examples are: zip code, company name, VAT number, street address, etc.

Configuration Parameters are similar to Environment variables, but their value is chosen by customers before placing an order.

Each parameter is created and bound to a specific Product, but can be linked or not to one or more Plan” (Product Version). Each parameter can be marked as required, and its value can be validated by providing a regular expression. In order to support customers to fully understand the meaning, each parameter has a description and a hint.

To specify a Configuration Parameter, enter the Product editing page, then select the “Conf. Parameters” tab. For each parameter you need to specify:

  • Code: a unique identifier of the parameter. It is not shown to the customer
  • Name: a name for the parameter. It will be shown to the customer so it has to be clear.
  • Description: a short explanation provided to the end-users
  • Validation (optional): a regular expression to validate the text provided by end-users
  • Hint: text inside the placeholder that helps end-users to complete the field
  • Required (yes/no): sets if the customer needs to specify a value for the parameter before purchasing the product

control_panel_configuration_parameters_editing

 

Once Configuration Parameters are specified for a product, they need to be attached to one (or more) “Plans” or product versions. To do that, click on the “Plans” tab, select a specific Plan and click on the “Edit” button. You will see a pop-up similar to the one shown in the following picture: go to the “Features” tab and select one or more Configuration Parameters to activate for the specific Plan.

control panel configuration parameters linking
The Cloudesire API gives the vendor the possibility to retrieve both a specific Configuration Parameter definition and the related parameters “value” (namely the valued specified by the customer during the order placement).

Configuration Parameters values can be retrieved via API fetching the Subscription object:

GET /api/subscription/2388 HTTP/1.1

Partial example body:

{
         ....
         "configurationParameters": {
            "configurationParameter/2095": "param1 value", 
            "configurationParameter/2096": "param2 value"
         } ....
}

To fetch the definition of a specific parameters you can invoke:

GET /api/configurationParameter/2095 HTTP/1.1

Partial example body:

{
    "code": "PAR01",
    "description": "Your blog domain",
    "hint": "Specify the domain from which your blog will be reachable",
    "id": 2095,
    "name": "domain",
    "required": true,
    "self": "configurationParameter/2095",
    "validation": "^(?:[-A-Za-z0-9]+\.)+[A-Za-z]{2,6}$"
}

If your application provisioning type is Deployed, the Configuration Parameters are automatically injected in the VM for deployed applications as an environment variable with the same name of the code parameter: in case you have created a Configuration Parameter with COLOR as code, your application will have a $COLOR environment variable with the value chosen by the customer.

Plans

  • plans show one or more available product versions (e.g. silver, gold, platinum, etc.): each version (or “plan”) can have a specific recurrent license and/or a one-off setup price or can be offered for free. There are so many options that we wrote a section entirely dedicated to plans and pricing models. We strongly recommend you to read it before you define plans for your product. You can find more information about pricing models here.

SSL (only for “Deployed” Applications)

  • The vendor’s SSL certificate and SSL certificate private key (to be used to access the VM containing the running instance of the application)

Advanced Settings (only for admins)

  • some additional parameters

Billing Information (Plans)

What are plans

For each application, vendors can define one or more Plans (or “Versions”, e.g. silver, gold, platinum, etc.).

In short, plans are the product versions that will be available for your product. In the following picture, you can see an example of the two product versions created for a product: one is the monthly plan and one is the annual plan.

Vendors Control Panel: Edit Product page - Plans

How to add Plans to your product

To add plans you need to go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Catalog” from the menu on the left. Then you need to select the product you want to edit, click on it, select “Edit” and go to the “Plans” section.

Then, click on the “Create New Plan” button at the top right of the screen. You can now create your product plan.

If you have already created a plan and you want to edit you can do it by selecting a specific Plan, and clicking on the “Edit” button. A popup will show up, similar to the one in the following picture: 

Vendors Control Panel: Edit Product page - Plans - details

For each Plan the vendor has to specify the following information:

General

  • Plan Name (text): this is the name of the plan and will be shown to customers, so try to keep it easy to understand. For example, you product could have a gold/silver/platinum versioning, a basic/pro/enterprise versioning, a monthly/annual versioning and so on.
  • Plan Description (text): in this field you need to describe the features of that specific plan.  If your application is available in Italian and English, do not forget to add the long and short description in both languages. You can switch language with the flag on the right.
  • Published (yes/no): if set to “yes” customer will see this version and will be able to activate it.
  • External ID: this ID is useful to refer a custom “external” identifier for the specific plan

Features:

  • Configuration Parameters: a selection of the previously specified (at the product level) parameters. More details here.
  • Trials Allowed (yes/no):  you can allow a trial for your product version. We suggest to enable trials of product.
  • Trial length (in days): the duration of the “trial mode”, if offered to the customers for the specific Plan.
  • Auto-renewal (yes/no): if “yes”, the plan will auto-renew when the subscription is about to expire. For example, a monthly subscription could renew automatically each month. More details here.

Pricing:

  • Product Price (per billing period): it is the recurrent price that will be billed to the customer for that product version at each billing period, for example 10 EUR per month.
  • Activation Fee: one-off price that the customer will pay only once, when the order is placed in the marketplace. It is a setup fee.
  • Revenue Sharing Quota: only for admins
  • Deployment fee (optional, only for admins)
  • Billing frequency (in months): how often the customer will be billed for this product version. For example, it could be monthly, bimonthly, yearly, etc. (for further information see this section).
  • Short Living Subscription (yes/no): it’s also possible to specify a short-time billing frequency; that means that the subscription duration will be less than a day, and needs to be specified in hours.

Extra-Resources

  • Extra-resources: they are goods or services which can be sold together with the application. Examples are a 10-days pack of Technical Support, some hardware components, extra credits, etc. For further information see this section.

Advanced Settings

  • Self-billing (yes/no): for admin only. If this flag is enabled, Cloudesire will not issue any invoice to the customers (this task will be in carche of the vendor) and the application deployment process will start automatically when the customer clicks on the “buy now” button, without redirecting him to the payment gateway.

2.1.Pricing Models #

In this section we will focus on pricing models. The Pricing Model configuration section is one of the most important aspects of product configuration. Since it directly influences your product sales, it is important to understand which the most common pricing models available on the platform.

You can deeply customize the pricing model for your product in Cloudesire (for example, you can add extra resources to your product LINK), but the choice of the right pricing model is not always easy. That’s why in the following paragraphs you will find an introduction to the most used pricing models in SaaS businesses.

Available pricing models

There are many different basic pricing models that you can implement in Cloudesire. To define a pricing model, you need at least one product into your catalog. To access the catalog, go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Catalog” from the menu on the left. Then select the product, then “Edit” and go to the “Plans” tab.You can edit or add new plans to your product.

Freemium Model

The Freemium model is a good way to find new customers for your application. With this model, you allow customers to use your application with basic features for free and switch to premium features in paid plans.

The challenging aspect is that you need to find ways to push customers to switch to premium versions: this means that you need to define the pricing model with at least two product versions and understand which features of your product could push users to pay. For example, premium version could include more users, more credits, more storage or more services than the free version: you need to understand which is the right hook.

Examples of SaaS business using this model are Hootsuite and Dropbox.

Pricing Models: freemium

Pay-as-you-go Model

Pay as you go model means that your users pay only for what they use, so it’s a good choice if you want to reduce the entry barrier for customers. This offers flexibility to customers, but your product needs to have an effective metering system. Also, you need to understand how to segment your offer. Usually, you lower the price of items for larger volumes, so that users are pushed to buy more items to save money.

iStock is an example of Pay as you go pricing model

Pricing Models: pay as you go

Pay-per-user Model

Pay per user Model means that your customers move up and down the tier automatically, so the cost scales according to how they use the product. For example, you pay 30$/month up to 10 users and 50$/month up to 15 users. The challenging aspect of this model is that you do not have a constant flow of revenues, they can move up and down and it’s not predictable.

Slack is an example of a SaaS business that follows this model.Pricing Models: pay per user model

Fixed Pricing Model

The Fixed Pricing Model is a good way to offer different versions of your product to different targets and generate consistent revenues. If you have a product that can target different customers and you can define different pricing tiers, you could benefit from the fixed pricing model.

For example, you could create a silver version for freelance professionals, a gold version for small companies and a platinum version for large companies.

Hubspot is a successful example of business that offers a fixed pricing model.

Pricing Models: fixed price model

Feature Based Model

Feature Based model means that you create different pricing tiers based on features. The challenging aspect of this model is that you need to identify which features add to each tier, so that customers are willing to pay up to get them.

Salesforce is an example of a business that offers a feature based model.

Pricing models: Feature Based model

 

 

 

 

3.Extra Resources #

In this section you will learn what extra resources are and how you can add them to your product

Understand Extra Resources

Extra Resources refer to goods or services which can be sold together with the application (for example, a 10-days pack of Technical Support, hardware components, extra credits, etc.).  A detailed explanation of this concept is available on this section.

How to add extra resources to your product

To insert a new Extra Resource, you need to have at least one product in your catalog (draft or published). If you have at least one product in your catalog, go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Catalog” from the menu on the left. Then you need to select the product you want to edit, click on it, select “Edit” and go to the “Plans” section. Then, select the plan you want to add extra resources to, select “Edit” and then go to the “Extra Resources” section

You will be required to add:

  • Resource Name:  the name of the extra resource. It will be shown to the customer in the marketplace.
  • Identifier for the resource: please make sure this is a unique indentifier for the extra resource.
  • Measuring Unit: the measuring unit of the extra resource, for example hours, credits etc. You can select the measuring unit from the drop-down menu
  • Type:  you will be able to chose from a drop-down menu among “Tiered”, “Volume” and “Stairstep”. Basically, they are the pricing models for “extra-resources”, based on quantity usages. Tiered scheme means that every unit charge is calculated with its own tier price (for example, from 1 to 9 users: €5/user and from 10 users: €3/user. Quantity bought= 15 users, total amount: 9 * € 5,00 + 6 * € 3,00 = € 63,00). Volume scheme means that all units charge is calculated based on total count in the related tier (for example, from 1 to 9 users: €5/user and from 10 users: €3/user Quantity bought= 15 users, total amount: 15 units * € 3,00 = € 45,00) Stairstep scheme means that total cost is calculated based on price tier; charge is not per unit (for example from 1 to 9 users: €30 and from 10 users: €100. Quantity bought= 15 users, total amount: € 100,00).  You can find more details about it here.
  •  Description: a short description of the extra resource. Please try to be clear and brief.
  • Required (yes/no) if the customer has to buy this resource to complete the product activation.

then, click on the “Add” button on the right.

Vendors Control Panel - Extra Resources (editing)

The next step is to specify the quantity usages rules and the pricing model.
Go to the “Extra Resources Values” section and select from the combo-box on the left a previously inserted Resource Name. Then, specify the minimum and maximum quantities, the Unit Price and the optional Activation Fee (setup fee) .

Vendors Control Panel - Extra Resources (editing values)

In this way, you can add multiple Extra Resources, when you’re done click on the “Save” button.

The following screenshot shows an example of Extra Resources linked to a specific Product Plan.

Vendors Control Panel - Extra Resources

How to retrieve the actual extra-resources values

To retrieve the Extra Resources Values specified by the customer during the order placement, you can fetch the Subscription resource using the Cloudesire API:

GET /api/subscription/{id} HTTP/1.1

The response will contain the information explained in this section, plus the billingItems property, which contains – for each Extra Resource entity – the chosen value.

HTTP/1.1 200 OK
Content-Type: application/json

{
    ...
    "billingItems": {
        "billingItem/1": 100,
        "billingItem/2": 50,
    },
    ...
}

4.Technical Onboarding #

This section focuses on the technical aspects of the onboarding. We made the technical onboarding as smooth as possible, anyway we strongly recommend you to read this section before onboarding your product and during the onboarding process.

Onboarding for Syndicated and Deployed Applications

The technical part of the onboarding process depends on the application provisioning type:

  • for Syndicated Applications (namely directly managed by the software vendor, and not hosted on the Cloudesire platform itself) the software vendor has to provide a “syndication endpoint” and proceed with the integrations via API, as described in this section
  • for Deployed Applications (where Cloudesire will provision on the cloud a new VM containing a running instance of the app for each customer) the software vendor has 2 possibilities: ZIP Application Package (a simple archive containing both the source code and the SQL scripts of the application) and Docker Packaging (a self-contained archive of your application meeting the Docker standards). More detailed instruction for the onboarding of Deployed Applications can be found in this section.

The following sections refer to other additional functionalities, which can be used both in the Syndication and Self-Deploy scenarios.

4.1.Application Metrics #

Understand Application Metrics

Application Metric (AKA Custom Metrics) represents facts of a specific application offered in the Cloudesire Marketplace that are relevant to software vendors.

For example, a software vendor could be interested to know how many documents a certain application instance produced in the last month, or how many active users an application has at a given time.

This kind of information are useful for monitoring purposes (i.e. to see a dynamic real-time graph in the Cloudesire Dashboard), but also allows software vendors to implement pay-per-use pricing models. In fact, specifying a unit-price for a custom metric (eg. 10 USD per active user) allows Cloudesire to calculate the related incomes in a certain period of time (billing period) and issue an invoice to the customer. For further details, take a look at the Billing Module Section.

For each metric you can define from the application metric editing section, the following information:

  • Name: a metric unique identifier;
  • Endpoint: must be defined in the form of a relative URL (e.g.: /metric/users);
  • Polling frequency: the platform will poll your endpoint with this frequency;
  • Measuring unit: the drop-down menu includes units like Item, Users, Hours, MB, GB, Invoice,…;
  • Unit-price (optional): price charged for each application metric value received.

How to add Custom Metrics

The steps to follow to a add one (or more) Custom Metric to a Product – or Product version(s) – are slightly different depending on your application provisioning type:

Adding Custom Metrics to a Syndicated Application

For Syndicated Applications, you need to access to the product editing page and go to the “Metric” tab.

To find the “Metric” tab go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Catalog” from the menu on the left. Then you need to select the product you want to add custom metrics to, click on it, select “Edit” and go to the “Metrics” section.

In the following picture you can see an example of a “Metrics” section.

Vendors Control Panel - Custom Metrics (Syndicated apps, list)

By clicking on “Add New Metric“, you will see a pop-up where you can set up a new metric.

Fields are:

  • Name: the name of the metric you want to monitor
  • Polling frequency: the frequency you want the platform to poll your endpoint
  • Measuring unit: select the right measuring unit from the drop-down menu, according to the metric you want to monitor
  • Custom Endpoint: the URL you want the platform to poll your endpoint. It must be defined in the form of a relative URL (e.g.: /metric/users)
  • Unit Price (optional): the price charged for each application metric value received
  • Type: select Counter or Gauge from the dropdown menu. A counter is a cumulative metric that represents a single numerical value that only ever goes up, while a gauge is a metric that represents a single numerical value that can arbitrarily go up and down.

Vendors Control Panel - Custom Metrics (Syndicated apps, insertion)

Adding Custom Metrics to a Deployed Application

For Deployed Applications, you need to access to the “Modules” section (more details here.)

To access the “Modules” section go to marketplace.cloudesire.com, select “log-in” at the top right corner  of the screen, enter your username and password (or follow the instructions to create a new vendor account) and click on your username at the top right corner to access your personal Control Panel. You will be able to access the “Modules” from the menu on the left.

Once you are in the “Modules” section, , select a specific Module and Package (more details here), click on the “Show Advanced” button on the top-right of the page. Furthermore, by accessing to the “Application Metrics” tab it’s possible to fill all the required fields and click on the “Add” button to finish.

Vendors Control Panel - Custom Metrics (Deployed apps, insertion)

How to provide “actual values” for a Custom Metric

To be able to successfully use application metrics, your application should expose an unique URL for each application metric, reporting the value for that metric.

The format of the metric data should be in JSON format:

{
    "metricsName": "current_users",
    "value": 3.0
}

4.2.Configuration Parameters #

Applications may require a list of parameters that have to be filled by customers before using the application for the first time, either for the application to work properly or to provide better initial customization (more details here). Examples are: zip code, company name, VAT number, street address, etc.

Configuration Parameters are similar to Environment variables, but their value is chosen by customers before placing an order.

Each parameter is created and bound to a specific Product, but can be linked or not to one or more Plan” (Product Version). Each parameter can be marked as required, and its value can be validated by providing a regular expression. In order to support customers to fully understand the meaning, each parameter has a description and a hint.

To specify a Configuration Parameter, enter the Product editing page, then select the “Conf. Parameters” tab. For each parameter you need to specify:

  • Code: a unique identifier of the parameter. It is not shown to the customer
  • Name: a name for the parameter. It will be shown to the customer so it has to be clear.
  • Description: a short explanation provided to the end-users
  • Validation (optional): a regular expression to validate the text provided by end-users
  • Hint: text inside the placeholder that helps end-users to complete the field
  • Required (yes/no): sets if the customer needs to specify a value for the parameter before purchasing the product

control_panel_configuration_parameters_editing

 

Once Configuration Parameters are specified for a product, they need to be attached to one (or more) “Plans” or product versions. To do that, click on the “Plans” tab, select a specific Plan and click on the “Edit” button. You will see a pop-up similar to the one shown in the following picture: go to the “Features” tab and select one or more Configuration Parameters to activate for the specific Plan.

control panel configuration parameters linking
The Cloudesire API gives the vendor the possibility to retrieve both a specific Configuration Parameter definition and the related parameters “value” (namely the valued specified by the customer during the order placement).

Configuration Parameters values can be retrieved via API fetching the Subscription object:

GET /api/subscription/2388 HTTP/1.1

Partial example body:

{
         ....
         "configurationParameters": {
            "configurationParameter/2095": "param1 value", 
            "configurationParameter/2096": "param2 value"
         } ....
}

To fetch the definition of a specific parameters you can invoke:

GET /api/configurationParameter/2095 HTTP/1.1

Partial example body:

{
    "code": "PAR01",
    "description": "Your blog domain",
    "hint": "Specify the domain from which your blog will be reachable",
    "id": 2095,
    "name": "domain",
    "required": true,
    "self": "configurationParameter/2095",
    "validation": "^(?:[-A-Za-z0-9]+\.)+[A-Za-z]{2,6}$"
}

If your application provisioning type is Deployed, the Configuration Parameters are automatically injected in the VM for deployed applications as an environment variable with the same name of the code parameter: in case you have created a Configuration Parameter with COLOR as code, your application will have a $COLOR environment variable with the value chosen by the customer.

4.3.Auto-login #

Understand auto-login

If you enable auto-login, your customers will be able to access your application without providing any specific credential (typically username and password).

Why you should use auto-login

It would be great to give the customer the possibility to auto-login to your application without providing any credentials, especially in a marketplace. For instance, it means that your customer will not need to remember credentails for Cloudesire platform AND your product. Also, you will not need to provide end-user instructions to the customer to login for the first time to your application. Long story short, you can provide your customer a smooth and simple user experience.

How to enable auto-login

To achieve this goal, we strongly suggest to add an authorization token to the endpoint to access the application. In this way, you can recognize the customer and enable automatical log-in into your application.

If you follow this flow, you don’t need to specify the user credentials into the end-user instructions anymore.

In-Depth info:

5.Integration Facilities #

In this section you will find an overview of the integration facilities provided by Cloudesire to help developers during the onboarding process.

Staging Marketplace

Why you should use the Staging Marketplace

While developing the integration with the Cloudesire platform, it’s useful to run some tests on our Staging Marketplace. On the staging marketplace where fake payments with demo credit cards are possible and where you can test the whole customer journey, end-to-end.

We strongly recommend to test applications on the staging marketplace to discover integration issues before the application is published on the marketplace.

Staging Marketplace URL and API endpoint:

The Staging Marketplace for software vendors is available at the following URL:

https://frontend-staging-vendors.cloudesire.com/

The API endpoint for the staging marketplace is:

https://staging-vendors.cloudesire.com/api/

On this marketplace you can freely create as many accounts as you wish, both vendor and customers, and you can use the testing credit cards of Stripe or Paypal.

TIPS:

  • Please remember to change the API endpoint to the production URL (https://backend.cloudesire.com/api/) in your source code before you publish your application in the product marketplace, otherwise subscriptions will not run correctly.
  • To give you the best customer experience preview, you can create vendor and customer profiles. To create a staging profile go to https://frontend-staging-vendors.cloudesire.com/cp/register/as, select “Register as Vendor?” to create a vendor account or “Register as Customer?” to create a customer account . Then, create your own vendor or customer account following the instructions on the screen.

How to test the customer experience on the Staging Marketplace

In order to fully test your integration source code, once you have finished the application onboarding process we strongly suggest you to:

Once the application is ready (the entire process shouldn’t require more than a few minutes) you will see in your dashboard an interface similar to the following screenshot (which refers to a running trial) 

Customer Dashboard - My Apps

By clicking on the “Launch [application_name]” button the customer will be redirected to a view where:

  • the application runs in the body of the page
  • the header of the page contains the running application name and version and provides some tools (bookmark, end-user instructions, customer profile details, etc.). This header will be also used to provide useful notifications (subscription about to expire, private messages, etc.). Also, from this section customers will be able to go back to Cloudesire.
  • a customer support tool is available (to give the customer the possibility to send direct messages both to the platform admins and vendors). Those messages will be managed by an integrated trouble-ticketing system

Customer Dashboard - running app

Sandbox orders

What are sandbox orders and why you should use them

Sandbox orders are fake orders in which vendors can test the deployment workflow of their applications. Even if they are not real orders, they simulate a real purchase scenario, so that vendors can identify integration issues in their workflow before applications are available to the public.

How to launch a sandbox order

To launch a sandbox, you need to have at least one product in your catalog: this means that you have already uploaded at least one application on the staging marketplace  (if you do not know how to onboard an application on Cloudesire platform, click here) If you already have at least one application in your catalog go to https://frontend-staging-vendors.cloudesire.com/, select “log-in” at the top right corner of the screen, enter your staging vendor username and password and click login. Then click on your username at the top right to access your personal Control Panel. Click “Catalog” from the menu at the top left of the screen to see your applications. Once you know which application you want to test, go to “Plans” and select “SANDBOX”. 

In the following picture you can see an example of the page from which you can launch a sandbox order. If you do not know how to configure a plan for your product, click here.

Vendors Control Panel: Syndication - Sandboxing

6.Video Tutorials #

Multilangual Interface & Product Page

Configuration Parameters

Product Plans: General Info & Configurations

Product Plans: Pricing

Product Plans: Metrics’ Prices

Extra Resources

Coupons

Vendor Dashboard

Help Guide Powered by Documentor
Suggest Edit