Menu:

API Quickstart

Steps to implementing the API on your site

1) Add the widget to Weebly. Adding elements is not difficult for us, and the process can be completed in minutes with the proper information. If your widget is not yet included in Weebly, email chris@weebly.com with details of your widget. Please include the code necessary to include your widget on a page, as well as any options (ex. Skin), the options titles (ex. 'Blue', 'Green', 'Yellow'), and the corresponding code to change from your snippet (ex. ?skin=(b/g/y)) -- this will help us include the widget as soon as possible.

Note: We will be releasing utilities to allow users and publishers to create their own elements in the near future. For now, the Weebly team can assist you in getting your widget included. Allowing a user to copy and paste HTML/Javascript code is contrary to our usability and design principles -- instead of having a user copy and paste code, we'll add that user's code as an element, so that all users can benefit from this functionality.

2) Download a copy of the "Add to Weebly" button, available at http://www.weebly.com/weebly/images/add_to_weebly.png .

3) Have your site generate a link to the API script, as detailed in the API specifications. You'll need the API version, your element's Element ID, the appropriate Content Field IDs, as well as the Content Field Property IDs -- this sounds difficult, but will be simple in practice. Using a simple widget (say, an RSS reader) with element ID 1, one content field with ID 15 (the javascript for the reader), and three properties with IDs 100 (ex theme), 101 (ex minutes), and 102 (ex URL), the link will look like:

http://www.weebly.com/weebly/importElement.php?api=1&element=1
&15.100=yellow&15.101=20&15.102=rssfeed1.google.com

Please remember to encode any special characters, such as an '&'.

If you need any help, please feel free to contact Chris Fanini at chris@weebly.com.