Personal tools

From HEXONET Wiki

Jump to: navigation, search
(Created page with "{{Sidebar}} <div style="font-size: 150%;">'''Weebly API'''</div><br/> <p> fnelwfoejfw.... == List of plans == {| class="wikitable" style="width:60% !important" |- ! scope=...")
 
Line 27: Line 27:
  
 
== Using the API ==
 
== Using the API ==
−
 
 
<br/><br/>
 
<br/><br/>
  
 
= Create website =
 
= Create website =
 
== Create new website user ==
 
== Create new website user ==
−
<br>
 
 
To create a new website, a website user object must first be created. Please note that a website user object is different than a contact handle that's used for domains.
 
To create a new website, a website user object must first be created. Please note that a website user object is different than a contact handle that's used for domains.
  
Line 43: Line 41:
 
LANGUAGE = (Primary language)
 
LANGUAGE = (Primary language)
 
</pre>
 
</pre>
−
 
+
<br/>
 
'''CLASS'''
 
'''CLASS'''
 
<br>
 
<br>
Line 76: Line 74:
  
 
==Create new website==
 
==Create new website==
−
<br>
 
 
Once you have created a website user, you can use the following command to create the website
 
Once you have created a website user, you can use the following command to create the website
  
Line 89: Line 86:
 
REFERENCE = (Original website ID to copy from) (optional)
 
REFERENCE = (Original website ID to copy from) (optional)
 
</pre>
 
</pre>
−
 
+
<br/>
 
'''CLASS'''
 
'''CLASS'''
 
<br>
 
<br>
Line 126: Line 123:
  
 
= Query website =
 
= Query website =
 +
== Get website status ==
 +
You can see all information on your website using the following command
 +
 +
<pre>
 +
COMMAND = StatusWebsite
 +
ID = (Website ID)
 +
</pre>
 +
 +
StatusWebsite will return the following property:
 +
 +
* WEBSITEUSERID
 +
* STATUS
 +
* TITLE
 +
* DESCRIPTION
 +
* CREATEDDATE
 +
* PEERUSER
 +
* SUBCLASS
 +
* RENEWALMODE
 +
* PAIDUNTILDATE
 +
* ID
 +
 +
== Access Weebly Site Editor ==
 +
To access the Weebly Site Editor interface, you need to retrieve the SSO link using the following command
 +
 +
<pre>
 +
COMMAND = CreateWebsiteSession
 +
ENTITY = Site
 +
ID = (Website ID)
 +
</pre>
 +
 +
This command will return the property URL which redirects to the Weebly Site Editor.
 +
 +
== Get website list ==
 +
You can view a list of your website using the following command
 +
 +
<pre>
 +
COMMAND = QueryWebsiteList
 +
</pre>
 +
 
= Upgrade website =
 
= Upgrade website =
 +
{{Warnbox|Please note that downgrading is not supported for Weebly website plans}}
 +
 +
== Upgrade via API ==
 +
You can upgrade your website by using the following command
 +
 +
<pre>
 +
COMMAND = UpgradeWebsite
 +
ID = (Website ID)
 +
CLASS = (Website class)
 +
</pre>
 +
<br>
 +
 +
'''ID'''
 +
<br>
 +
The website ID
 +
 +
'''CLASS'''
 +
<br>
 +
Website plan. Valid plan are:
 +
* WEEBLY_FREE
 +
* WEEBLY_STARTER
 +
* WEEBLY_PRO
 +
* WEEBLY_BUSINESS
 +
* WEEBLY_PERFORMANCE
 +
 +
== Povisioning upgrade within Weebly Site Editor ==
 +
In the Weebly Site Editor, there's an upgrade button that allows user to upgrade the website while they're still in the Site Editor screen. Upon click, this button will open a new pop-up modal to provision the upgrade process. You can see more information on how upgrade works in the Weebly Site Editor at https://cloud-developer.weebly.com/cl_gs_upgrades.html
 +
 
= Other commands =
 
= Other commands =
 
<headertabs/>
 
<headertabs/>

Revision as of 16:27, 4 April 2019

Weebly API

fnelwfoejfw....

List of plans

Annual plan API Class Main features
Free WEEBLY_FREE 2 million queries
Starter WEEBLY_STARTER 5 million queries
Pro WEEBLY_PRO 15 million queries
Business WEEBLY_BUSINESS 30 million queries
Performance WEEBLY_PERFORMANCE 50 million queries

See here for a breakdown of plans ...

Using the API



Create new website user

To create a new website, a website user object must first be created. Please note that a website user object is different than a contact handle that's used for domains.

The following command is used to create the website user object 

COMMAND = CreateWebsiteUser
CLASS = Weebly
EMAIL = (Email address)
LANGUAGE = (Primary language)


CLASS
This must always be set to Weebly

EMAIL
Email address to serve as your primary contact for important Weebly emails. Weebly provides notices and information about your websites regarding customer comments, registrations, purchases and more.

LANGUAGE
The primary language used in the Weebly interface. Valid language code are:

  • DA: Danish
  • DE: German
  • EN: English
  • ES: Spanish
  • FR: French
  • IT: Italian
  • JA: Japanese
  • NL: Dutch
  • NO: Norwegian
  • PL: Polish
  • PT: Portuguese
  • RU: Russian
  • SV: Swedish
  • TR: Turkish
  • ZH: Chinese (simplified)


If successful, CreateWebsiteUser will return a WEBSITEUSERID property.

Create new website

Once you have created a website user, you can use the following command to create the website 

COMMAND = CreateWebsite
CLASS = (Website class)
DOMAIN = (Domain name)
WEBSITEUSERID = (Website User ID)
PERIOD = 1Y
SECURE = 0 | 1
TITLE = (New website title) (optional)
REFERENCE = (Original website ID to copy from) (optional)


CLASS
Website plan. Valid plan are:

  • WEEBLY_FREE
  • WEEBLY_STARTER
  • WEEBLY_PRO
  • WEEBLY_BUSINESS
  • WEEBLY_PERFORMANCE

DOMAIN
Name of domain. You can also use an external domain name. Note that the domain name must be unique and is not in used by another account.

WEBSITEUSERID
Website user object ID

PERIOD
Registration period of the website. Currently only supports period of 1 year (1Y).

SECURE
This property will either hide or show the SSL certificate option in the Site Editor so that users can enable SSL on their website

  • If set to 1, this will show the SSL certificate option in the Site Editor
  • If set to 0, this will hide the SSL certificate option in the Site Editor

TITLE
Website title. If not specified, the default value will be 'Blank title'.

REFERENCE
If you provide the ID of another website, the new website will copy the existing website

Get website status

You can see all information on your website using the following command 

COMMAND = StatusWebsite
ID = (Website ID)

StatusWebsite will return the following property:

  • WEBSITEUSERID
  • STATUS
  • TITLE
  • DESCRIPTION
  • CREATEDDATE
  • PEERUSER
  • SUBCLASS
  • RENEWALMODE
  • PAIDUNTILDATE
  • ID

Access Weebly Site Editor

To access the Weebly Site Editor interface, you need to retrieve the SSO link using the following command 

COMMAND = CreateWebsiteSession
ENTITY = Site
ID = (Website ID)

This command will return the property URL which redirects to the Weebly Site Editor.

Get website list

You can view a list of your website using the following command 

COMMAND = QueryWebsiteList

Please note that downgrading is not supported for Weebly website plans


Upgrade via API

You can upgrade your website by using the following command 

COMMAND = UpgradeWebsite
ID = (Website ID)
CLASS = (Website class)


ID
The website ID

CLASS
Website plan. Valid plan are:

  • WEEBLY_FREE
  • WEEBLY_STARTER
  • WEEBLY_PRO
  • WEEBLY_BUSINESS
  • WEEBLY_PERFORMANCE

Povisioning upgrade within Weebly Site Editor

In the Weebly Site Editor, there's an upgrade button that allows user to upgrade the website while they're still in the Site Editor screen. Upon click, this button will open a new pop-up modal to provision the upgrade process. You can see more information on how upgrade works in the Weebly Site Editor at https://cloud-developer.weebly.com/cl_gs_upgrades.html

Retrieved from "https://wiki.hexonet.net/index.php?title=Weebly_API&oldid=8350"