{"id":9656,"date":"2024-05-28T06:51:23","date_gmt":"2024-05-28T06:51:23","guid":{"rendered":"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/quick-reference\/quickstart-marketplace-app\/"},"modified":"2024-05-29T08:21:51","modified_gmt":"2024-05-29T08:21:51","slug":"quickstart-marketplace-app","status":"publish","type":"docs","link":"https:\/\/accuweb.cloud\/api\/docs\/latest\/quick-reference\/quickstart-marketplace-app\/","title":{"rendered":"Quickstart.Marketplace.App"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-post\" data-elementor-id=\"9656\" class=\"elementor elementor-9656\" data-elementor-post-type=\"docs\">\n\t\t\t\t<div class=\"elementor-element elementor-element-8c15557 e-flex e-con-boxed e-con e-parent\" data-id=\"8c15557\" data-element_type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-7def7a7 elementor-widget elementor-widget-text-editor\" data-id=\"7def7a7\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.23.0 - 05-08-2024 *\/\n.elementor-widget-text-editor.elementor-drop-cap-view-stacked .elementor-drop-cap{background-color:#69727d;color:#fff}.elementor-widget-text-editor.elementor-drop-cap-view-framed .elementor-drop-cap{color:#69727d;border:3px solid;background-color:transparent}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap{margin-top:8px}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap-letter{width:1em;height:1em}.elementor-widget-text-editor .elementor-drop-cap{float:left;text-align:center;line-height:1;font-size:50px}.elementor-widget-text-editor .elementor-drop-cap-letter{display:inline-block}<\/style>\t\t\t\t<p class=\"has-line-data\" data-line-start=\"2\" data-line-end=\"3\">This article guides you through installing applications on Accuweb.cloud&#8217;s Application Marketplace using their\u00a0<code>Quickstart.Marketplace.App.Install<\/code> API. This API allows for quick and efficient deployment of pre-configured applications.<\/p><p class=\"has-line-data\" data-line-start=\"4\" data-line-end=\"5\"><strong>What is the Accuweb.cloud Application Marketplace?<\/strong><\/p><p class=\"has-line-data\" data-line-start=\"6\" data-line-end=\"7\">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.<\/p><p class=\"has-line-data\" data-line-start=\"8\" data-line-end=\"9\"><strong>Using the Quickstart.Marketplace.App.Install API ( <a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/marketplace\/app\/\">refer for more<\/a> )<\/strong><\/p><p class=\"has-line-data\" data-line-start=\"10\" data-line-end=\"11\">The APIs offers a straightforward process for deploying applications. Here&#8217;s a breakdown of the key points:<\/p><p data-sourcepos=\"14:1-14:19\"><strong>Authentication:<\/strong><\/p><p>You can authenticate using either an application ID (<code>appid<\/code>) or a user session token (<code>session<\/code>).<\/p><p><strong>URL:<\/strong> https:\/\/[hoster-api-host]\/1.0\/marketplace\/app\/rest\/install<\/p><h3 id=\"api-parameters-1\" class=\"code-line\" data-line-start=\"2\" data-line-end=\"3\">API Parameters<\/h3><ul><li style=\"list-style-type: none;\"><ul><li class=\"has-line-data\" data-line-start=\"4\" data-line-end=\"5\"><strong>appid (optional):<\/strong>\u00a0Unique identifier for your target application (required for authentication if no session is provided).<\/li><li class=\"has-line-data\" data-line-start=\"5\" data-line-end=\"6\"><strong>session (optional):<\/strong>\u00a0Your user session token or a <a class=\"wpil_keyword_link\" href=\"https:\/\/accuweb.cloud\/api\/docs\/latest\/others\/personal-access-tokens\/\"   title=\"personal access token\" data-wpil-keyword-link=\"linked\"  data-wpil-monitor-id=\"1582\">personal access token<\/a> (refer to the\u00a0<a title=\"user session\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/users\/authentication\/#signin-appid-login-password-authenticationresponse\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"1211\">user session<\/a>\u00a0or\u00a0<a title=\"personal access token\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/personal-access-tokens\/\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"415\">personal access token<\/a> for details on obtaining these).<\/li><li class=\"has-line-data\" data-line-start=\"21\" data-line-end=\"22\"><strong>id<\/strong>\u00a0(string): Unique identifier of the target JPS manifest in the Marketplace.<\/li><li class=\"has-line-data\" data-line-start=\"22\" data-line-end=\"23\"><strong>envName<\/strong>\u00a0(string): Target environment name.<\/li><li class=\"has-line-data\" data-line-start=\"23\" data-line-end=\"24\"><strong>settings<\/strong>\u00a0(string): JSON object with custom settings for the JPS manifest.<\/li><li class=\"has-line-data\" data-line-start=\"24\" data-line-end=\"25\"><strong>displayName<\/strong>\u00a0(string): Custom alias (display name) for the deployed application.<\/li><li class=\"has-line-data\" data-line-start=\"25\" data-line-end=\"26\"><strong>region<\/strong>\u00a0(string): Target environment region.<\/li><li class=\"has-line-data\" data-line-start=\"26\" data-line-end=\"27\"><strong>envGroups<\/strong>\u00a0(string): Target environment group name or JSON array of group names.<\/li><li class=\"has-line-data\" data-line-start=\"27\" data-line-end=\"28\"><strong>ownerUid<\/strong>\u00a0(int): Unique identifier of the target user account.<\/li><li class=\"has-line-data\" data-line-start=\"28\" data-line-end=\"29\"><strong>nodes<\/strong>\u00a0(string): JSON object with a list of environment nodes and their settings.<\/li><li class=\"has-line-data\" data-line-start=\"29\" data-line-end=\"30\"><strong>overrideNodes<\/strong>\u00a0(boolean): Defines whether to override (true) or merge (false) nodes from the \u2018nodes&#8217; parameter with the nodes specified in the manifest.<\/li><li class=\"has-line-data\" data-line-start=\"30\" data-line-end=\"31\"><strong>skipEmail<\/strong>: (optional)\u00a0<code>boolean<\/code>\u00a0Defines whether to send an email after the successful installation (false) or not (true).<\/li><li class=\"has-line-data\" data-line-start=\"31\" data-line-end=\"33\"><strong>skipNodeEmails<\/strong>: (optional)\u00a0<code>boolean<\/code>\u00a0Defines whether to send emails after the new nodes creation (false) or not (true).<\/li><\/ul><\/li><\/ul><h3 id=\"sample-request\" class=\"code-line\" data-line-start=\"40\" data-line-end=\"41\">Sample Request<\/h3><p class=\"has-line-data\" data-line-start=\"42\" data-line-end=\"43\"><strong>URL:<\/strong> https:\/\/[hoster-api-host]\/1.0\/marketplace\/app\/rest\/install<\/p><p class=\"has-line-data\" data-line-start=\"44\" data-line-end=\"45\"><strong>POST Fields:<\/strong><\/p><pre><code class=\"has-line-data\" data-line-start=\"47\" data-line-end=\"53\">{\n  \"<span class=\"hljs-attribute\">session<\/span>\": <span class=\"hljs-value\"><span class=\"hljs-string\">\"user session token\"<\/span><\/span>,\n  \"<span class=\"hljs-attribute\">shortdomain<\/span>\": <span class=\"hljs-value\"><span class=\"hljs-string\">\"unique_string\"<\/span> (avoid duplicates with existing environments)<\/span>,\n<span class=\"hljs-value\">   \"id\": \"string\" (here we will use '<strong>wordpress'<\/strong> for instance, for list refer \"<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/quick-reference\/common-variables\/\">here<\/a>\")\n<\/span>}<\/code><\/pre><h3 id=\"sample-response-1\" class=\"code-line\" data-line-start=\"59\" data-line-end=\"60\">Sample Response<\/h3><p class=\"has-line-data\" data-line-start=\"61\" data-line-end=\"62\">The response will be similar to the following, indicating successful deployment:<\/p><pre><code class=\"has-line-data\" data-line-start=\"64\" data-line-end=\"77\">{\n  \"result\": 0,\n  \"uniqueName\": \"...\",  \/\/ Unique identifier for the deployment\n  \"startPage\": \"...\", \/\/ URL to check you application\n  \"response\": {\n    \"result\": 0,\n    \"uniqueName\": \"...\",  \/\/ Unique identifier for the environment\n    \"startPage\": \"...\", \/\/ URL to check you application\n    \"successText\": \"...\", \/\/ Other Relevant information (like your wordpress admin panel details for this case)\n    \"appid\": \"...\"       \/\/ Unique identifier for the application\n  },\n  \"appid\": \"...\"  \/\/ Unique identifier for the application\n  \"successText\": \"\" \/\/ Other Relevant information (like your wordpress admin panel details for this case)\n}<\/code><\/pre><p class=\"has-line-data\" data-line-start=\"39\" data-line-end=\"40\">The\u00a0<code>Quickstart.Marketplace.App.Install<\/code> 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.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>This article guides you through installing applications on Accuweb.cloud\u2019s Application Marketplace using their\u00a0Quickstart.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 [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9376,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_links_to":"","_links_to_target":""},"doc_tag":[],"class_list":["post-9656","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9656","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/comments?post=9656"}],"version-history":[{"count":5,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9656\/revisions"}],"predecessor-version":[{"id":9763,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9656\/revisions\/9763"}],"up":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9376"}],"wp:attachment":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/media?parent=9656"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/doc_tag?post=9656"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}