site.get_domains
api_key
login
Gets the list of domains for a given user. Returns the following structure:
{
"domains": [ "", "", ... ]
}
site.set_domains
api_key
login
domains — an array of domains to set
Returns the same structure as site.get_domains.
site.designs.get_configuration
auth_token
file — the web path to the file that keeps the requested design configuration
Returns the following structure:
{
"configuration": <...JSON with the configuration of the design here...>
}
site.designs.get_categories
auth_token (optional)
Gets the categories of designs available to the reseller if auth_token is not supplied. If auth_token is supplied, gets the design categories available to the user. Returns the following structure:
{
"categories": <...JSON with the categories of the design here...>
}
site.designs.get_collections
auth_token (optional)
package_code (optional)
language (optional)
Gets the available design collections. If package_code is supplied, the collections available to the specified package are returned. Otherwise, if auth_token is supplied, the collections available to the user are returned. If neither auth_token nor package_code are supplied, the collections of the reseller's default Trial package are returned.
{
"collections": <...JSON with the collections here...>
}
site.stock_images.get_collections
auth_token - the current session fetched by SK.Singletons.env.get( "session_id" )
Returns a list of all collections of stock images:
{
"collections": [
{
"id": "<the collection ID>",
"caption": "<caption here...>",
"available_sizes": [ "preview", "medium", "large" ] /* any of these */
},
{
"id": ...
},
...
]
}
site.stock_images.get_images
auth_token
collection_id - the ID of the collection to get images for
Returns an array of images in the collection:
{
"images": [
{
"id": "<the image ID>",
"caption": "<the image caption>",
"sizes": {
"preview": "<url here>",
"medium": "<url here>",
"large": "<url here>"
},
"keywords": [
"keyword1",
"keyword2",
...
]
}
]
}
site.stock_fonts.get_fonts
auth_token
Returns a list with details about the available fonts:
{
"font_definitions": [
{
"family": "Angelina",
"local": "Angelina",
"src": {
"woff": "//fonts.nccdn.net/Angelina/Angelina-Regular.css"
}
},
{
"family": "Arvo",
"local": "Arvo",
"src": {
"woff": "//fonts.nccdn.net/Arvo/Arvo.css"
}
},
...
]
}
site.set_home_page
auth_token
node_id - the NodeID of the page
Sets the home page of the site.
site.set_404_page
auth_token
node_id - the NodeID of the page
Sets the given page NodeID as the "Not Found" page of the site. Any requests to invalid URLs will be redirected to this page.
site.unset_404_page
auth_token
Unsets the "Not Found" page of the site. Requests to invalid URLs will show the system's default "Not Found" page.
site.redirect.add
auth_token
properties - JSON key-value object which must have:
name - user-friendly name of the redirect
path - path which should be redirected to the specified link
link - either an external URL, or a Page NodeID
Creates a redirect which will redirect all requests to "path" to "link". Returns redirect_id
site.redirect.update
auth_token
properties - JSON key-value object which must have:
name - user-friendly name of the redirect
path - path which should be redirected to the specified link
link - either an external URL, or a Page NodeID
Updates the properties of a redirect. Returns all the properties of the redirect.
site.redirect.remove
auth_token
redirect_id - ID of the redirect
Removes the specified redirect.
site.redirect.get
auth_token
redirect_id - ID of the redirect
Returns the properties of the specified redirect.
site.redirect.get_all
auth_token
Returns the properties of all redirects.
site.folder.add
auth_token
properties - JSON key-value object which must have:
name - user-friendly name of the folder
path - path of the folder
Creates a folder which can hold pages. Returns folder_id. Refer to object.page.move_to_folder for details on how to move a page to a folder.
site.folder.update
auth_token
properties - JSON key-value object which must have:
name (optional)
path (optional)
Updates the properties of a folder. Returns all the properties of the folder.
site.folder.remove
auth_token
folder_id - ID of the folder
Removes the specified folder.
site.folder.get
auth_token
folder_id - ID of the folder
Returns the properties of the specified folder.
site.folder.get_all
auth_token
Returns the properties of all folders.
site.static_file.add
auth_token
url - the URL of the file which should be added as static file
Adds a static file. Returns the ID of the added file
site.static_file.remove
auth_token
id - the ID of the file which should be removed, as returned by APIs site.static_file.add or site.static_file.get_all
Remove a static file.
site.static_file.get_all
auth_token
Returns all the static files of the account with the following structure:
{
"file_name": "filename1.ext",
"id": "123",
"url": "domain.com/filename1.ext"
}
site.export
api_key
login
Returns the following structure:
{
"content": <...JSON with site content...>
}
site.import
api_key
login
content - JSON object retuned by site.export API
replacements (optional) - JSON key-value object. The specified keys will be replaced with the corresponding values in the imported site.