API documentation

Create session (SSO)

Site.pro Builder is a session-based software. It means that it cannot be opened for a customer directly in browser but instead you need to get unique session URL for that customer using this API method.

To open builder you need to call API URL by posting JSON object with information about user, if all went successfully API will return JSON object with URL you will need to redirect client to, if error occurs API will return JSON object with error message. All request to API require HTTP Basic Authorisation. Username and password for API Authorisation can be found inside your brand on licenses page after you login to your account. All documentation on how to make requests to API and some request examples are below.

Currently builder supports 2 publishing types: external and internal:

• external – this type uses FTP account to publish website. During API call you need to pass FTP details which builder will use for site publication. Example implementation: Download here.
• internal – this type uses your API endpoint to publish website. During API call you need to pass your API endpoint URL which builder will call for site publication. Example implementation: Download here.

• external
• internal

POST /api/requestLogin HTTP/1.1
Host: your-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
   "type": "external",
   "domain": "test.com",
   "apiUrl": "11.22.33.44",
   "lang": "en",
   "username": "test.com FTP username",
   "password": "test.com FTP password",
   "uploadDir": "/public_html"
}
		

POST /api/requestLogin HTTP/1.1
Host: your-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
   "type": "internal",
   "domain": "test.com",
   "apiUrl": "http://myhostingsite.com/api/publish-site",
   "resellerClientAccountId": 1234,
   "lang": "en"
}
		

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

{
   "url": "http://your-builder-domain.com/?login_hash=4asf64df6465"
}
	

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
   "error": { "message": "some kind of error message" }
}
	

Remove existing session available since version 4.0.63 / 3.7.439

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String domain - domain related to this login hash used with parameter "domain" in "Create session" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Object error - (optional) Error description object (only on error). Error object structure:
  • String message - Text describing the error

List template categories

Get list of template categories as JSON.

JSON response Object Properties:

• String id - template category ID;
• String name - template category name;
• Number templateCount - number of templates contained in this category;

List templates

Get list of templates as JSON.

JSON response Object Properties:

• String id - template ID;
• String localId - template ID (relative to category);
• String categoryId - templates category ID;
• String name - template name;
• String image - template image URL;

Get page types available in template available since version 4.0.0 / 3.7.229 (on-premises only)

JSON request Object Properties:

• String template - template ID;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String template - (optional) returned on success, contains template;
• Array of String pageTypes - (optional) returned on success, contains list of page types;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Create website available since version 4.0.0 / 3.7.229 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/create.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String template - template ID to create website from;
• Array of String pageTypes - (optional) list of page types to indicate pages that need to be added from template (if not specified all pages will be added). List of available page types can be received by using "Get page types available in template" API call;
• Object variables - (optional) key value pair list of variables (reference IDs in template) and their values, that will replace website elements contents (available since version 3.7.256);
  Possible values for different element types:
  • String Text - text or HTML;
  • Object Picture - object containing the following properties:
    • String src - image URL/Data URL;
    • Link Object link - (optional) link data;
  • Object Shape - object containing the following properties:
    • Background background - background data;
    • Link Object link - (optional) link data;
  • Object Button - object containing the following properties:
    • String text - button text;
    • Link Object link - (optional) link data;
  • String GoogleMap - comma (,) separated coordinates;
  where:
  • Link Object - object containing the following properties:
    • String url - button URL (can also be of type "mail:" or "tel:");
    • String title - (optional) button title;
  • Background - object containing the following properties:
    • String color - (optional) background color (default: "transparent");
    • String image - (optional) background image URL (default: "none");
    • String position - (optional) background position (default: "left top");
    • String repeat - (optional) background repeat (default: "repeat");
    • String size - (optional) background size (default: "auto auto");
    • String attachment - (optional) background attachment (default: "scroll");

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String template - (optional) returned on success, contains template used to create website;
• Object pages - (optional) returned on success, contains key value pair list of created pages where key is page ID and value is page type;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Modify website available since version 4.0.0 / 3.7.229 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/modify.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Object variables - (optional) see "variables" parameter in Create website method;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Rename website available since version 4.0.0 / 3.7.295 (on-premises only)

JSON request Object Properties:

• String domain - domain you want to rename;
• String newDomain - new domain name;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Publish website available since version 4.0.0 / 3.7.350 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + publish.

This API is for publishing website. Publishing website consists of 2 or more API calls:
    1) use "Create session" API call with additional parameter more = true to get loginHash and builderApiUrl;
    2) with this API use received loginHash and builderApiUrl + 'publish' (as API URL) to initiate publishing process (when API call returns it only means that publishing has started);
    3) optionally call (same as in step 2) API call with additional parameter progress = true to get publishing progress (when you receive response with complete = true, then publishing process has completed);

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String processId - (optional) if set then progress of specified publication process will be returned, otherwise new publication process will be started and its process ID will be returned in the response;
• String template - (optional) template ID, if passed then current template (is exists) will be removed and replaced with this new template (all data will be lost);

JSON response Object Properties:

• String text - (optional) text describing current publish process progress;
• Number progress - (optional) numeric value from 0 to 100 to show progress completeness (note publishing consists of multiple actions so this value will go multiple times to 100, so do not rely on it);
• Boolean complete - (optional) if true then publishing process is complete;
• String error - (optional) error message, if this parameter is not empty that means publishing process stopped (unless this is authentication error);
• String processId - (optional) publication process ID (set only when requested for new publication, that is "processId" property was not set in the request);

Edit website pages available since version 4.0.50 / 3.7.430 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/edit-pages.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of Object pages - object containing the following structure:
  • String type - (optional) new page type. If passed, then "menuItem" -> "name" parameter will be ignored.
  • Object page - (optional) object containing the following structure:
    • String title - (optional) page title (defined in SEO settings).
    • String alias - (optional) page user friendly URL (defined in SEO settings).
  • Object menuItem - (optional) object containing the following structure:
    • String name - (optional) menu item name.
    • Boolean noMenu - (optional) indicates if menu item is hidden in Menu element.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Edit website settings available since version 4.0.46 / 3.7.374 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/settings.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Boolean publishWithForcedHttps - (optional) if true then published website will forcefully be redirected to HTTPS protocol; if false then no forced redirection will be applied;
• Boolean forceRedirectEnabled - (optional) possible values:
  • Number 0 - forced redirection will be not be applied to published website;
  • Number 1 - published website will forcefully be redirected to non-WWW domain version;
  • Number 2 - published website will forcefully be redirected to WWW domain version;
• Boolean disableRightClick - (optional) if true then context menu will not appear on published website when right-clicking website area with a mouse;
• Boolean forceSlashes - (optional) if true then published website will forcefully be redirected to URL with trailing slashes at the end (for example URL "http://website.com/about" will redirect to "http://website.com/about/"); if false then no forced redirection will be applied;
• String scriptCommonHead - (optional) custom code for field "Before </head>" for "Common" item;
• String scriptCommonBodyEnd - (optional) custom code for field "Before </body>" for "Common" item;
• String scriptCommonBodyStart - (optional) custom code for field "After </body>" for "Common" item;
• Page Scripts Object scriptPageHead - (optional) custom code for field "Before </head>" for specific pages;
• Page Scripts Object scriptPageBodyEnd - (optional) custom code for field "Before </body>" for specific pages;
• Page Scripts Object scriptPageBodyStart - (optional) custom code for field "After </body>" for specific pages;

• Page Scripts Object - associative array of custom code for specific pages. The object must be of structure:

  {
      "pageId1": "code1",
      "pageId2": "code2",
      ...
  }

  where pageId is ID of page which can be retrieved with Get website pages API method, and code is custom code for fields specified above in description of properties.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Enable Auto Layout available since version 3.7.412 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Disable Auto Layout available since version 3.7.412 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Delete website available since version 4.0.0 / 3.7.64 (on-premises only)

This API is for permanently deleting website from on-premises builder. This will only delete website project data from builder itself and leave published website intact.

• String domain - website domain name (required)

• Boolean ok - result of response (only on success)
• Object error - error description object (only on error). Error object structure:
  • String message - text describing the error

POST /api/delete-site HTTP/1.1
Host: your-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{"domain": "test.com"}

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

{"ok": true}

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

{"error": {"message": "some kind of error message"}}

Create website backup available since version 4.0.0 / 3.7.316 (on-premises only)

Creates site source file backup and stores locally on builder server or returns as downloadable file.

• String domain - domain name used to identify website witch will be backed up (required).
• String dir - absolute folder path inside builder server where to store backup file (optional, if not set backup file will be returned in response for downloading). When backup file is stored locally in provided folder it will have file name: "[domain]_project.sitebuilder".

On success you get empty response (in case of local storage) or response with a file for downloading. HTTP response code should be 200.
On error you will get JSON encoded object as response. HTTP response code should be something other than 200.

• Object error - error description object (only on error). Error object structure:
  • Number code - error code
  • String message - text describing the error

POST /api/create-site-backup HTTP/1.1
Host: your-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
    "domain": "site-to-backup.com",
    "dir": "/mnt/backup_storage"
}

HTTP/1.1 200 OK

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-disposition: attachment; filename="site-to-backup.com_project.sitebuilder"

[some binary data]

HTTP/1.1 500 Internal Error
Content-Type: application/json

{"error": {"code": 1, "message": "some kind of error message"}}

Restore website backup available since version 4.0.0 / 3.7.316 (on-premises only)

Restores site backup from local file or remote URL.

• String domain - domain name used to identify web-site witch will be restored from backup (required).
• String file - absolute path inside builder server or absolute external URL to backup file to restore from (required).

On success you will get JSON encoded object as response. HTTP response code should be 200.

• Boolean ok - it will be equal to true to indicate success.

On error you will get JSON encoded object as response. HTTP response code should be something other than 200.

• Object error - error description object (only on error). Error object structure:
  • Number code - error code
  • String message - text describing the error

POST /api/restore-site-backup HTTP/1.1
Host: your-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
    "domain": "site-to-restore.com",
    "file": "/mnt/backup_storage/site-to-restore.com_project.sitebuilder"
}

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

{"ok": true}

HTTP/1.1 500 Internal Error
Content-Type: application/json

{"error": {"code": 1, "message": "some kind of error message"}}

Get website template available since version 4.0.0 / 3.7.344 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/get-template.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String template - (optional) returned on success, contains template ID [category/template] used to create website;

Get website pages available since version 4.0.0 / 3.7.344 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/get-pages.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Boolean excludeInternal - if set to true response will not contain menu items that have isInternal set to true;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Array of Object pages - (optional) returned on success, contains list of website pages. Each page object has following structure:
  • String type - page type.
  • Object page - part of page definition containing the following structure:
    • String id - page ID.
    • String title - page title (defined in SEO settings).
    • String alias - page user friendly URL (defined in SEO settings).
    • Boolean popupMode - indicates if page is popup.
    • Number popupWidth - popup page width (set only if page is popup).
    • Number popupHeight - popup page height (set only if page is popup).
  • Object menuItem - part of page definition containing the following structure:
    • String name - menu item name.
    • Boolean noMenu - indicates if menu item is hidden in Menu element.
    • Boolean isInternal - indicates if menu item is a link to a page in another menu.

Get website variables available since version 4.0.0 / 3.7.388 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/get-variables.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Object variables - (optional) key value pair list of variables (reference IDs in template) and their values used when creating website using "Create website" API call;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Get website settings available since version 4.0.0 / 3.7.374 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/get-settings.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - returned on success, contains value true, indicates successfully executed action;
• Object data - object containing the following properties:
  • Boolean publishWithForcedHttps - if true then published website will forcefully be redirected to HTTPS protocol; if false then no forced redirection will be applied;
  • Boolean forceRedirectEnabled - possible values:
    • Number 0 - forced redirection will be not be applied to published website;
    • Number 1 - published website will forcefully be redirected to non-WWW domain version;
    • Number 2 - published website will forcefully be redirected to WWW domain version;
  • Boolean disableRightClick - if true then context menu will not appear on published website when right-clicking website area with a mouse;
  • Boolean forceSlashes - if true then published website will forcefully be redirected to URL with trailing slashes at the end (for example URL "http://website.com/about" will redirect to "http://website.com/about/"); if false then no forced redirection will be applied;
  • String scriptCommonHead - custom code for field "Before </head>" for "Common" item;
  • String scriptCommonBodyEnd - custom code for field "Before </body>" for "Common" item;
  • String scriptCommonBodyStart - custom code for field "After </body>" for "Common" item;
  • Page Scripts Object scriptPageHead - custom code for field "Before </head>" for specific pages;
  • Page Scripts Object scriptPageBodyEnd - custom code for field "Before </body>" for specific pages;
  • Page Scripts Object scriptPageBodyStart - custom code for field "After </body>" for specific pages;
  
  where:
  • Page Scripts Object - associative array of custom code for specific pages. The object must be of structure:

    {
        "pageId1": "code1",
        "pageId2": "code2",
        ...
    }

    where pageId is ID of page which can be retrieved with Get website pages API method, and code is custom code for fields specified above in description of properties.

Add pages to website available since version 4.0.0 / 3.7.229 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/add-pages.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String template - template id to add pages from;
• Array of String pageTypes - list of page types to indicate pages that need to be added from template. List of available page types can be received by using "Get page types available in template" API call;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String template - (optional) returned on success, contains template used to add pages from;
• Object pages - (optional) returned on success, contains key value pair list of created pages where key is page ID and value is page type;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Duplicate pages in website available since version 4.0.0 / 3.7.229 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/duplicate-pages.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of String pages - list of page IDs to indicate pages that need to be duplicated;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Array of String pages - (optional) returned on success, contains ID list of created pages;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Remove pages from website available since version 4.0.0 / 3.7.229 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/remove-pages.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of String pages - list of page IDs to indicate pages that need to be removed;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Array of String pages - (optional) returned on success, contains ID list of removed pages (will only contain pages that were actually removed, if they did not exist they will not be in this list);
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Import website available since version 4.0.0 / 3.7.312 (on-premises only)

This API action allows to import website to the builder without any user interaction.

Import limits specified in maxPages, maxFiles, maxGallerySize, maxImageSize, maxDocumentSize are capped at limits set by Site.Pro. For example setting maxPages to 1000 will still be reduced to 20 unless we had this limit increased.

Please be aware that once import is successfully complete old website is fully replaced with imported one.

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/import-begin.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String url - URL of a website to import;
• Number maxPages - (optional) maximum number of pages that import service can try to import from the website (defaults to 20 unless increased by Site.Pro);
• Number maxFiles - (optional) maximum number of files that can be downloaded into media library (defaults to 1000 unless increased by Site.Pro);
• Number maxGallerySize - (optional) maximum bytes that are allowed to be imported into media library (defaults to 52428800 [50MB] unless increased by Site.Pro);
• Number maxImageSize - (optional) maximum bytes allowed for image files (jpg, png, gif) (defaults to 3145728 [3MB] unless increased by Site.Pro);
• Number maxDocumentSize - (optional) maximum bytes allowed for files other than images (defaults to 20971520 [20MB] unless increased by Site.Pro);
• Boolean autoLayoutEnabled - (optional) tells import service whether "Auto Layout" mode should be enabled on imported website (defaults to true);

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String id - (optional) returned on success, contains import task ID that must be used with "Get import status" API call;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Get import status available since version 4.0.0 / 3.7.312 (on-premises only)

This API action returns status of import task created with "Import website" API call.

Once import task is finished further "Get import status" API calls will return error "Import task not found.". Import task is considered finished on two conditions:

• complete property of returned status object is set to true (successful import),
• or error property exists in returned status object (unsuccessful import).

Please be aware that once import is successfully complete old website is fully replaced with imported one.

Make sure to do periodic "Get import status" API calls after starting import (recommended period is 3 to 10 seconds) since otherwise after 30 seconds of "silence" import service may consider the task to be abandoned and abort it.

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/import-status.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String id - import task ID received from "Import website" API call;
• Boolean getPages - (optional) if set to true response will contain extra parameter "pages" after importing is done;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• TaskStatus status - (optional) returned on success, contains status of import task;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;
• Object pages - (optional) total list of website pages after importing is done (the same which can be retrieved from "Get website pages" API call); returned only when importing task is complete and if request has "getPages" property set to true;

TaskStatus object properties:

• Boolean complete - value of true indicates that import task was completed successfully and website was replaced with imported one;
• Object error - (optional) returned only if there is an error related to import task. This object has following properties:
  • Boolean allowRetry - value of true indicates that potentially the error is only temporary and trying to import same URL again has a chance to succeed;
  • String message - error message from import service related to the import task. This message is displayed in builder to users, may be translated and may contain HTML code;
  • Number code - numeric code of error message from import service (see table below);
• String text - (optional) current import task status text as displayed to users in builder (may be translated and contain HTML). This property will be available only if there are no errors and builder is still connected to import service;
• Number progress - (optional) overall import task progress percentage (0 to 100). This property will be available only if there are no errors and builder is still connected to import service;
• Object steps - (optional) import task progress information divided into steps (processes). This property will be available only if there are no errors and builder is still connected to import service. This object has following properties:
  • StepProgress waiting - progress of waiting in import service queue;
  • StepProgress reading - progress of reading (crawling) website;
  • StepProgress processing - progress of processing found HTML pages;
  • StepProgress downloadingGallery - progress of downloading resources (images, documents, etc.) into media library;
  • StepProgress finalizing - progress of loading imported website into builder;

StepProgress object properties:

• String state - status of step (process). Possible values are:
  • pending - not yet started,
  • active - currently in progress,
  • done - finished and will no longer be returned to.
• String text - step name as displayed in builder (may be translated and contain HTML code);
• Number progress - step progress percentage (0 to 100);
• String progressText - step progress in form of text as displayed in builder over progress bar (may be translated and contain HTML code);

Possible values of TaskStatus.error.code:

Create empty website available since version 4.0.61 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/create-site.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of String languages - (optional) list of language locale codes to add to website (ex. en_US);
• String defaultLanguage - (optional) language locale code to mark as default language (ex. en_US);
• String or Object title - (optional) websites default title, for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object description - (optional) websites default meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object keywords - (optional) websites default meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Modify website available since version 4.0.61 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/modify-site.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of String languages - (optional) list of language locale codes to replace current languages (ex. en_US);
• String defaultLanguage - (optional) language locale code to mark as default language (ex. en_US);
• String or Object title - (optional) websites default title, for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object description - (optional) websites default meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object keywords - (optional) websites default meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Inspect website available since version 4.0.61 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/inspect-site.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• Object site - (optional) website descriptor:
  • Array of String languages - list of language locale codes (ex. en_US);
  • String defaultLanguage - language locale code for default language (ex. en_US);
  • Object or String title - websites default title, for multi-language websites is an object where field name is language code (ex. en) and value is translation for that language;
  • Object or String description - websites default meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
  • Object or String keywords - websites default meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
  • Array of Object pages - page descriptor:
    • Number id - page id;
    • Object or String title - page title, for multi-language websites is an object where field name is language code (ex. en) and value is translation for that language;
    • Object or String description - page meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
    • Object or String keywords - page meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String error - (optional) if action failed then this will contain error message;

Add empty page available since version 4.0.62 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/add-page.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String or Object title - page title, for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object description - (optional) page meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object keywords - (optional) page meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• Boolean isPopup - (optional) if true then this page is popup page and can be used as popup;
• Number popupWidth - (optional) popup width (in pixels);
• Number popupHeight - (optional) popup height (in pixels);
• Number openPopupId - (optional) popup page ID to be opened when this page is opened;
• Array of String sections - list of page sections that need to be created (available array items: header, body, footer);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• Number pageId - (optional) created page ID;
• String error - (optional) if action failed then this will contain error message;

Modify page available since version 4.0.62 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/modify-page.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to modify;
• String or Object title - (optional) page title, for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object description - (optional) page meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• String or Object keywords - (optional) page meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
• Boolean isPopup - (optional) if true then this page is popup page and can be used as popup;
• Number popupWidth - (optional) popup width (in pixels);
• Number popupHeight - (optional) popup height (in pixels);
• Number openPopupId - (optional) popup page ID to be opened when this page is opened;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Remove page available since version 4.0.59 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/remove-page.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Array of Number items - list of page IDs to remove;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Inspect page available since version 4.0.62 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/inspect-page.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to inspect;

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• Object page - (optional) page descriptor:
  • Number id - page id;
  • Object or String title - page title, for multi-language websites is an object where field name is language code (ex. en) and value is translation for that language;
  • Object or String description - page meta description (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
  • Object or String keywords - page meta keywords (used for SEO), for multi-language websites pass an object where field name is language code (ex. en) and value is translation for that language;
  • Boolean isPopup - if true then this page is popup page and can be used as popup;
  • Number popupWidth - (optional) popup width (in pixels);
  • Number popupHeight - (optional) popup height (in pixels);
  • Number openPopupId - (optional) popup page ID to be opened when this page is opened;
  • Object sections - block distribution in sections:
    • Array of String header - (optional) header blocks creation composition ID list (ex. default/232), only available for blocks created with this API;
    • Array of String body - (optional) body blocks creation composition ID list (ex. default/232), only available for blocks created with this API;
    • Array of String footer - (optional) footer blocks creation composition ID list (ex. default/232), only available for blocks created with this API;
• String error - (optional) if action failed then this will contain error message;

Inspect composition available since version 4.0.59 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/inspect-composition.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• String compositionId - composition ID to inspect (ex. default/232);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• Array of Object items - (optional) list of element descriptors, descriptor structure:
  • String id - elements reference ID;
  • String type - elements type;
• String error - (optional) if action failed then this will contain error message;

Modification descriptor structure by element type

JSON LayoutElement Object Properties:

• Object spacing_ (optional)
  • Number paddingTop
  • Number paddingRight
  • Number paddingBottom
  • Number paddingLeft
  • Number marginTop
  • Number marginRight
  • Number marginBottom
  • Number marginLeft
• Object background - (optional) background descriptor:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object border - (optional) border descriptor:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object borderRadius - (optional) corner rounding descriptor:
  • Number lt - left top corner roundness;
  • Number rt - right top corner roundness;
  • Number rb - right bottom corner roundness;
  • Number lb - left bottom corner roundness;
  • Boolean differ - (optional) if false only lt value will be used for all corners;
• Boolean isSticky - (optional) if true element will not move with page when scrolled;
• String stickyAlign - (optional) sticky alignment (one of left top, center top, right top, left middle, right middle, left bottom, center bottom or right bottom);

JSON TextArea Object Properties:

• String text - (optional) text elements HTML content;

JSON Picture Object Properties:

• String src - (optional) image URL;
• String alt - (optional) alternative text;
• Object border - (optional) border descriptor:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object corners - (optional) corner rounding descriptor:
  • Number lt - left top corner roundness;
  • Number rt - right top corner roundness;
  • Number rb - right bottom corner roundness;
  • Number lb - left bottom corner roundness;
  • Boolean differ - (optional) if false only lt value will be used for all corners;
• Number opacity - (optional) image opacity in percentage (range: 0 - 100);
• Object link - (optional) link that will be opened when clicked:
  • String type - link type (one of url - link to external website, page - link to page (page needs to be added to menu) on this website, email - mailto:link or phone - tel:link);
  • String or Number url - link subject (different depending on type): url - URL to open (ex.: https://site.pro/), page - menu item ID in menu specified by menuUID property to open (ex.: 1), email - email address (ex.: someones@email.com), phone - phone number (ex.: +12345678912);
  • String menuUID - (optional) menu elements unique ID (only for page type) (ex.: 81a1a609);
  • String target - (optional) link target (only for url and page types) (ex. _blank to open link in a new window);
  • String anchor - (optional) anchor name to link to specific section (only for page type) (ex.: someplace);
  • String title - (optional) link title (will be shown as tooltip on mouse over);
  • Boolean nofollow - (optional) if true add rel="nofollow" to the link;
  • Boolean popup - (optional) if true then this link will open as popup (only for url and page types);
  • Number popupWidth - (optional) popup width (in pixels);
  • Number popupHeight - (optional) popup height (in pixels);

JSON Gallery Object Properties:

• String type - (optional) gallery type;
• Number interval - (optional) slide show interval (in seconds);
• Number speed - (optional) slide show speed (in seconds);
• String bgColor - (optional) gallery background CSS color;
• Array of String images - (optional) image list;
• Object border - (optional) border descriptor:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Number padding (optional)
• Number thumbWidth - (optional) thumbnail width;
• Number thumbHeight - (optional) thumbnail height;
• String thumbAlign - (optional) thumbnail alignment (one of left, center or right);
• Number thumbPadding - (optional) thumbnail padding;
• Boolean imageCover - (optional) if true auto crop;
• Boolean disablePopup - (optional) if true do not enlarge picture on click;
• Boolean hideArrows - (optional) if true hide slideshow arrows;
• String showPictureCaption - (optional) caption visibility (one of always or hover);
• String captionBackground - (optional) caption background CSS color;
• Object captionTitleStyle - (optional) caption title style:
  • String color - (optional) text CSS color;
  • Number size - (optional) CSS font size (in pixels);
  • String font - (optional) CSS font face;
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • String align - (optional) CSS text alignment (one of left, center or right);
  • Number lineHeight - (optional) CSS line height (in pixels);
  • Number letterSpacing - (optional) CSS letter spacing (in pixels);
  • String textTransform - (optional) CSS text transform;
• Object captionDescriptionStyle - (optional) caption description style:
  • String color - (optional) text CSS color;
  • Number size - (optional) CSS font size (in pixels);
  • String font - (optional) CSS font face;
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • String align - (optional) CSS text alignment (one of left, center or right);
  • Number lineHeight - (optional) CSS line height (in pixels);
  • Number letterSpacing - (optional) CSS letter spacing (in pixels);
  • String textTransform - (optional) CSS text transform;

JSON Youtube Object Properties:

• String videoId - Youtube video ID;
• String startAt - (optional) start video from time (ex.: 00:12);
• Boolean showControls - (optional) if false hide video player controls;
• Boolean nocookieDomain - (optional) if true video player will use no/less cookies;

JSON Vimeo Object Properties:

• String groupId - video ID;
• String finalGroupId - same value as groupId;
• String portrait - (optional) portrait mode (1 - Yes, 0 - No);
• String title - (optional) show title (1 - Yes, 0 - No);
• String autoplay - (optional) auto-play (1 - Yes, 0 - No);
• String color - (optional) CSS color code;

JSON Spotify Object Properties:

• String type - (optional) type (one of play or follow);
• String size - (optional) size (one of basic or detail);
• String bg - (optional) color theme (one of dark or light);
• Number showCount - (optional) show count (1 - show, 0 - hide);
• String link - (optional) URL to spotify playlist (for type play) or artist (for type follow);

JSON MusicPlayer Object Properties:

• Array of String audioUrl - (optional) list of music file URLs;
• Boolean autoPlay - (optional) if true will start playing on load;

JSON GoogleMaps Object Properties:

• String address - (optional) Textual address;
• String ll - (optional) coordinates (latitude, longitude) (ex. 1.234567,1.234567);
• Number zoom - (optional) zoom level;
• String mapTypeId - (optional) map type (one of hybrid, roadmap, satellite, terrain);
• String key - (optional) Google Maps API key;
• String theme - (optional) color theme (one of default, light, dark or monochrome);
• String color - (optional) CSS color for monochrome color theme;
• Boolean showSatellite - (optional) if true show map type changer;
• Boolean showZoom - (optional) if true show zoom control;
• Boolean showStreetView - (optional) if true show street view control;
• Boolean showFullscreen - (optional) if true show full screen control;
• Boolean allowDragging - (optional) if true allow dragging;
• Boolean showRoads - (optional) if true show roads overlay;
• Boolean showLandmarks - (optional) if true show roads overlay;
• Boolean showLabels - (optional) if true show labels;

JSON yandex_maps Object Properties:

• String apiKey - (optional) Yandex Maps API key;
• String address - (optional) textual address;
• Number zoomLevel - (optional) zoom level;
• String type - (optional) map type (one of yandex#map, yandex#satellite or yandex#hybrid);
• Array of Number ll - (optional) coordinates (latitude, longitude);

JSON bing_maps Object Properties:

• String apiKey - (optional) Bing Maps API key;
• String address - (optional) textual address;
• Number zoomLevel - (optional) zoom level;
• String coord - (optional) coordinates (latitude, longitude) (ex. 1.234567,1.234567);
• Number loc1 - (optional) latitude coordinate (same as in coord);
• Number loc2 - (optional) longitude coordinate (same as in coord);

JSON baidu_maps Object Properties:

• String groupId - (optional) group ID;
• String coords - (optional) coordinates (latitude, longitude) (ex.: 116.404, 39.915);
• String coordsFinal - (optional) same as int coords;
• Number zoom - (optional) zoom level;
• Boolean marker - (optional) if true show marker;
• Boolean animate - (optional) if true animate marker;

JSON Form Object Properties:

• Object fields - (optional) fields descriptor where field name is field number and field value is field descriptor object with fields:
  • Boolean checked - if true then will be used else not;
  • String type - field type (one of input, textarea, select, checkbox or file);
  • String name - name of the field;
  • String options - option list for select type fields;
  • Boolean required - if true then field will be required;
• String email - (optional) receiver email;
• String emailFrom - (optional) sender email;
• String subject - (optional) email subject;
• String sentMessage - (optional) message that is shown to user when form is sent;
• String button - (optional) form submit button text;
• Boolean smtpEnable - (optional) if true SMTP sending is enabled;
• String smtpHost - (optional) SMTP server host;
• String smtpPort - (optional) SMTP server port;
• String smtpEncryption - (optional) SMTP server encryption (one of tls or ssl);
• String smtpUsername - (optional) SMTP server username;
• String smtpPassword - (optional) SMTP server password;
• String recSiteKey - (optional) ReCaptcha site key;
• String recSecretKey - (optional) ReCaptcha secret key;
• String maxFileSizeTotal - (optional) max attachment file size;

JSON Button Object Properties:

• String text - (optional) button text;
• Object link - (optional) link that will be opened when clicked:
  • String type - link type (one of url - link to external website, page - link to page (page needs to be added to menu) on this website, email - mailto:link or phone - tel:link);
  • String or Number url - link subject (different depending on type): url - URL to open (ex.: https://site.pro/), page - menu item ID in menu specified by menuUID property to open (ex.: 1), email - email address (ex.: someones@email.com), phone - phone number (ex.: +12345678912);
  • String menuUID - (optional) menu elements unique ID (only for page type) (ex.: 81a1a609);
  • String target - (optional) link target (only for url and page types) (ex. _blank to open link in a new window);
  • String anchor - (optional) anchor name to link to specific section (only for page type) (ex.: someplace);
  • String title - (optional) link title (will be shown as tooltip on mouse over);
  • Boolean nofollow - (optional) if true add rel="nofollow" to the link;
  • Boolean popup - (optional) if true then this link will open as popup (only for url and page types);
  • Number popupWidth - (optional) popup width (in pixels);
  • Number popupHeight - (optional) popup height (in pixels);
• Object border - (optional) border descriptor:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object corners - (optional) corner rounding descriptor:
  • Number lt - left top corner roundness;
  • Number rt - right top corner roundness;
  • Number rb - right bottom corner roundness;
  • Number lb - left bottom corner roundness;
  • Boolean differ - (optional) if false only lt value will be used for all corners;
• Object txt - (optional) text font descriptor:
  • String font - CSS font face;
  • Number size - CSS font size (in pixels);
  • Number lineHeight - CSS line height (in pixels);
  • Number letterSpacing - CSS letter spacing (in pixels);
  • String align - CSS text alignment (one of left, center or right);
• Object txtNormal - (optional) text style for normal button state:
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • String color - (optional) text CSS color;
• Object bgNormal - (optional) background for normal button state:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object txtHover - (optional) text style for hover button state:
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • String color - (optional) text CSS color;
• Object bgHover - (optional) background for hover button state:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object txtActive - (optional) text style for active button state:
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • String color - (optional) text CSS color;
• Object bgActive - (optional) background for active button state:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;

JSON Menu Object Properties:

• String menuUID - (read-only) unique ID;
• Array of Object tree
  • String type - item type (one of page - ordinary page, external - URL to external website, anchor - link to specific section of this websites page);
  • Number targetId - page ID for page and anchor types (optional for anchor type and not required for external type);
  • Object or String name - (optional) name of this item, for multi-language websites is an object where field name is language code (ex. en) and value is translation for that language;
  • Object or String url - (optional) URL (only required for external type), for multi-language websites is an object where field name is language code (ex. en) and value is URL for that language;
  • String anchor - (optional) anchor name (only required for anchor type);
  • Boolean noMenu - (optional) if true will be hidden from menu;
• String menuType - (optional) menu type (one of hmenu - horizontal menu or vmenu - vertical menu);
• Boolean noCollapse - (optional) if true menu will not collapse on mobile;
• String menuItemTextTransform - (optional) menu item CSS text transform (ex.: uppercase);
• Array of Number menuItemPadding - menu item padding, list of 4 values (that represent top, right, bottom and left);
• Array of Number menuItemSpacing - menu item padding, list of 4 values (that represent top, right, bottom and left);
• String menuItemAlign - (optional) menu item alignment (one of left, center, right or justify);
• Object txtNormal - (optional) normal menu item text:
  • String color - (optional) text CSS color;
  • Number size - (optional) CSS font size (in pixels);
  • String font - (optional) CSS font face;
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • Number letterSpacing - (optional) CSS letter spacing (in pixels);
• Object txtHover - (optional) hover menu item text:
  • String color - (optional) text CSS color;
  • Number size - (optional) CSS font size (in pixels);
  • String font - (optional) CSS font face;
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • Number letterSpacing - (optional) CSS letter spacing (in pixels);
• Object txtActive - (optional) active menu item text:
  • String color - (optional) text CSS color;
  • Number size - (optional) CSS font size (in pixels);
  • String font - (optional) CSS font face;
  • Object style - (optional) text style:
    • Boolean italic - (optional) if true then text will be italic;
    • Boolean bold - (optional) if true then text will be bold;
    • Boolean underline - (optional) if true then text will be underlined;
  • Number letterSpacing - (optional) CSS letter spacing (in pixels);
• Object bgItemNormal - (optional) normal menu item background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object bgItemHover - (optional) hover menu item background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object bgItemActive - (optional) active menu item background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object bgMenu - (optional) menu background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object bgSubMenu - (optional) sub-menu background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object bgMobMenu - (optional) mobile menu background:
  • String color - (optional) background CSS color;
  • String image - (optional) background CSS image;
  • String position - (optional) background CSS position;
  • String attachment - (optional) background CSS attachment;
  • String repeat - (optional) background CSS repeat;
  • String size - (optional) background CSS size;
• Object brdMenu - (optional) menu border:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object brdNormal - (optional) normal menu item border:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object brdHover - (optional) hover menu item border:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object brdActive - (optional) active menu item border:
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;

JSON Languages Object Properties:

• String type - (optional) type of language selector (one of select or flags);
• Number flagSize - (optional) language selector flag size;
• Boolean flagUseSquare - (optional) if true then flags will be square instead of rectangular;
• Number flagSpacing - (optional) spacing between flags;
• Object flagBorder - (optional) normal flag border:
  • Boolean differRadius - (optional) if true then border radius is different and should contain 4 components;
  • Array of Number radius - (optional) border radius values, 1 or 4 components depending on differRadius value;
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;
• Object flagBorderActive - (optional) hover flag border:
  • Boolean differRadius - (optional) if true then border radius is different and should contain 4 components;
  • Array of Number radius - (optional) border radius values, 1 or 4 components depending on differRadius value;
  • Boolean differ - (optional) if true then basic border properties (color, style and weight) are different and each should contain 4 components;
  • Array of String color - hex encoded color values (ex. #ff0000 - for red color), 1 or 4 components depending on differ value;
  • Array of String style - style values (any of solid, dotted, dashed or double), 1 or 4 components depending on differ value;
  • Array of Number weight - border weight values (in pixels), 1 or 4 components depending on differ value;

Add blocks from compositions available since version 4.0.58 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/add.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number or String pageId - page ID to add block to;
• Array of Object items - list of block definitions, definition structure:
  • String compositionId - composition ID to use for block creation (composition IDs can be found in a tooltip when opening builder in template editing mode and mouse hovering composition in add composition dialog) (ex. default/232);
  • String position - position specifier for where to insert new block, it consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - insert before 0-th block (at the beginning), body[3] - insert before 3-rd block, body[] - append to the end);
  • Object data - (optional) descriptor of how composition elements should be modified before being inserted as block, where field name is composition elements referenceId and value is modification descriptor object (modification descriptor object will be different depending on element type);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Remove blocks available since version 4.0.58 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/remove.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to remove blocks from;
• Array of String items - list of position specifiers for what blocks to remove, specifier consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - remove 0-th block, body[3] - remove 3-rd block);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Move blocks available since version 4.0.58 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/move.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to move blocks in;
• Array of Object items - list of move descriptors, descriptor structure:
  • String from - position specifier for which block to move, specifier consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - move 0-th block, body[3] - move 3-rd block);
  • String to - position specifier for where to move block, specifier consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - move before 0-th block, body[3] - move before 3-rd block, body[] - move to then end);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Modify blocks available since version 4.0.58 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/modify.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to modify blocks at;
• Object items - map of blocks to modify, where field name is block position specifier that consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - modify 0-th block, body[3] - modify 3-rd block) and field value is descriptor object of how block elements should be modified, where field name is composition elements referenceId and value is modification descriptor object (modification descriptor object will be different depending on element type);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• String error - (optional) if action failed then this will contain error message;

Inspect block available since version 4.0.62 (on-premises only)

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website-blocks/inspect-block.

JSON request Object Properties:

• String loginHash - login hash you received from "Create session" API call;
• Number pageId - page ID to inspect;
• String position - position specifier for block to inspect, it consists of section name (one of header, body or footer) and position in square brackets (ex. body[0] - insert before 0-th block (at the beginning), body[3] - insert before 3-rd block);

JSON response Object Properties:

• Boolean ok - if true then action executed successfully else failed;
• Array of Object items - (optional) list of element descriptors, descriptor structure:
  • String id - elements reference ID;
  • String type - elements type;
  • Object data - modification descriptor object (modification descriptor object will be different depending on element type);
• String error - (optional) if action failed then this will contain error message;

Get list of published websites

JSON request Object Properties:

• Number offset - (optional) starting offset in the list of domains;
• Number limit - (optional) maximum number of domains to return;
• Number brandId - (optional) if is set then will search domains using specified brand;
• Boolean free - (optional) if is set then will filter only free domains (published with "Free" plan) or only non-free domains depending on value (true or false);
• String domain - (optional) if is set then will return info about this domain only (will ignore limit and offset);

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Array of Object domains - (optional) returned on success, contains a list of domains. Each domain object has the following structure:
  • String domain - domain name;
  • Boolean blocked - blocking state of the domain: false for not blocked and true for blocked domains;
  • Number brandId - brand ID the domain is using;
  • Boolean free - indicates whether domain is free (published with "Free" plan) or not;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Get statistics of publications/openings

JSON request Object Properties:

• Number brandId - (optional) if is set then will search statistics of specified brand;
• String action - (optional) can be either "published" or "opened";
• String domain - (optional) if is set then will search statistics of specified domain;
• String dateFrom - (optional) if is set then will search statistics from specified date (must have format of "YYYY-MM-DD HH:MM:SS");
• String dateTo - (optional) if is set then will search statistics till specified date (must have format of "YYYY-MM-DD HH:MM:SS");

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Array of Object list - (optional) returned on success, contains a list of statistics. Each object has the following structure:
  • String domain - domain name;
  • String action - either "published" or "opened"
  • String date - action date of format "YYYY-MM-DD HH:MM:SS";
  • String error - set if action is "published" and ended with error, otherwise is null;
  • Number brandId - brand ID the domain is using;
  • Boolean free - indicates whether domain is free (published with "Free" plan) or not;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Block/unblock published website

This API is for controlling accounts (published websites).

Example Implementation
Download here.

JSON request Object Properties:

• String domain - websites domain to block/unblock;
• Boolean value - if true will be blocked, if false will be unblocked.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• String domain - (optional) returned on success, contains domain;
• Boolean value - (optional) returned on success, contains blocked state;
• String error - (optional) returned on error, contains error message, indicates failure to execute action;

Controlling IP list

This API request has multiple functions accessible via same URL. Function that must be performed on the IP list must always be specified in the action parameter of each request.

Example Implementation
Download here.

Getting simple IP list

JSON request Object Properties:

• String action = list.
• Number suborderId - ID of a license to get IP list for.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Number maxQuantity - (optional) max. number of IPs that can be added to this license.
• Array of String list - (optional) returned on success, contains list of IP's.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Getting extended IP list

JSON request Object Properties:

• String action = list-full.
• Number suborderId - ID of a license to get IP list for.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Number maxQuantity - (optional) max. number of IPs that can be added to this license.
• Array of Objects list - (optional) returned on success, contains list of IP's and assigned brands. Each IP object has following structure:
  • String ip - an IP address.
  • Number brandId - ID of brand assigned to IP.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Adding a new IP

JSON request Object Properties:

• String action = add.
• Number suborderId - ID of a license to add IP to.
• String ip - IP you want to add.
• Number brandId - ID of a registered brand to assign.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Updating an IP

JSON request Object Properties:

• String action = update.
• Number suborderId - ID of a license to update IP in.
• String ip - IP you want to update.
• String newIp - IP to update to (optional if brandId is specified).
• Number brandId - ID of a registered brand to assign (optional if newIp is specified).

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Deleting an existing IP

JSON request Object Properties:

• String action = delete.
• Number suborderId - ID of a license to delete IP from.
• String ip - IP you want to delete.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

IP controlling example

POST /api/ipList HTTP/1.1
Host: site.pro
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
   "action": "list-full",
   "suborderId": 123456789
}

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

{
   "ok": true,
   "list": [
      {
         "ip": "192.66.66.1",
         "brandId": 12345
      },
      {
         "ip": "192.66.66.2",
         "brandId": 12345
      }
   ]
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
   "error": { "message": "some kind of error message" }
}

Allow/disallow domain in builder available since version 4.0.55 / 3.7.435 (on-premises only)

This API is for allowing/disallowing usage of builder per domain.

JSON request Object Properties:

• Array of Strings domains - list of domains to allow/disallow;
• Boolean allowed - if true will be allowed, if false will be disallowed.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;

Check if domains are allowed in builder available since version 4.0.55 / 3.7.435 (on-premises only)

This API is for checking whether specified domains are allowed to use in builder or not.
Note that this method also takes into account the value of builder configurable option builderStatusByDefault. (check this page for more details: Extra configuration).

JSON request Object Properties:

• Array of Strings domains - list of domains;

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
• Object data - object with mapping (domain => value) of specified domains. Example:

  {
      "domainA.com": true,
      "domainB.com": false,
      "domainC.com": true,
      ...
  }

Check if imported website is owned by user available since version 4.0.0 / 3.7.312

JSON request Object Properties:

• String key - integration API secret key that is entered in brand configuration (since v3.7.314).
• String domain - domain that must be checked if it is owned by the user.
• String id_domain - domain that is currently open in website builder.
• String id_ip - IP (for external publish type) or URL (for internal publish type) where current website is set to be published. See apiUrl property of "Create session" API request.
• String id_ext_reference_id - (optional) Copy of extReferenceId property passed to website builder with "Create session" API request. Available only when custom API is used to open website builder.

JSON response Object Properties:

• Boolean ok - value must be set to true when requested domain is owned by the user and website may be imported;

Example

POST /check-ownership.php HTTP/1.1
Host: your-domain.com
Content-Type: application/json

{
    "key": "",
    "domain": "example.com",
    "id_domain": "my-new-website.com",
    "id_ip": "192.66.66.1"
}

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

{
   "ok": true
}

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

{
    "ok": false
}