Quickstart.Marketplace.App

This article guides you through installing applications on Accuweb.cloud’s Application Marketplace using their Quickstart.Marketplace.App.Install API. This API allows for quick and efficient deployment of pre-configured applications.

What is the Accuweb.cloud Application Marketplace?

Accuweb.cloud offers a marketplace with pre-configured applications that automatically install on cloud. You can customize and integrate this marketplace widget into your own business offerings.

Using the Quickstart.Marketplace.App.Install API ( refer for more )

The APIs offers a straightforward process for deploying applications. Here’s a breakdown of the key points:

Authentication:

You can authenticate using either an application ID (appid) or a user session token (session).

URL: https://[hoster-api-host]/1.0/marketplace/app/rest/install

API Parameters

• • appid (optional): Unique identifier for your target application (required for authentication if no session is provided).
  • session (optional): Your user session token or a personal access token (refer to the user session or personal access token for details on obtaining these).
  • id (string): Unique identifier of the target JPS manifest in the Marketplace.
  • envName (string): Target environment name.
  • settings (string): JSON object with custom settings for the JPS manifest.
  • displayName (string): Custom alias (display name) for the deployed application.
  • region (string): Target environment region.
  • envGroups (string): Target environment group name or JSON array of group names.
  • ownerUid (int): Unique identifier of the target user account.
  • nodes (string): JSON object with a list of environment nodes and their settings.
  • overrideNodes (boolean): Defines whether to override (true) or merge (false) nodes from the ‘nodes’ parameter with the nodes specified in the manifest.
  • skipEmail: (optional) boolean Defines whether to send an email after the successful installation (false) or not (true).
  • skipNodeEmails: (optional) boolean Defines whether to send emails after the new nodes creation (false) or not (true).

Sample Request

URL: https://[hoster-api-host]/1.0/marketplace/app/rest/install

POST Fields:

{
  "session": "user session token",
  "shortdomain": "unique_string" (avoid duplicates with existing environments),
   "id": "string" (here we will use 'wordpress' for instance, for list refer "here")
}

Sample Response

The response will be similar to the following, indicating successful deployment:

{
  "result": 0,
  "uniqueName": "...",  // Unique identifier for the deployment
  "startPage": "...", // URL to check you application
  "response": {
    "result": 0,
    "uniqueName": "...",  // Unique identifier for the environment
    "startPage": "...", // URL to check you application
    "successText": "...", // Other Relevant information (like your wordpress admin panel details for this case)
    "appid": "..."       // Unique identifier for the application
  },
  "appid": "..."  // Unique identifier for the application
  "successText": "" // Other Relevant information (like your wordpress admin panel details for this case)
}

The Quickstart.Marketplace.App.Install API simplifies application deployment from market place on Accuweb.cloud. By leveraging the provided parameters, you can customize the deployment process according to your requirements.