Wikidot provides the Wikidot API (an Application Programming Interface) to all developers, which is what STE uses to connect to your wiki and make changes.
|
Table of Contents
|
Prerequisites
To use the Import, Export, or Preview features, you must prepare both your website and STE for using the API.
- Grab your API key from Wikidot Account Settings and enter it into the Preferences/Settings window. Read more.
- Make sure you are a member of the site that you wish to access and have permissions to view/edit the pages you want to access in your web browser.
- Prepare your site for API access by setting up permissions in Site manager (admin:manage), or asking your administrator to set up permissions for you.
What you can do
With the help of the API, you can create or edit pages (Export) and read the source code from pages (Import) using STE.
To export (create/edit pages, renaming pages, tagging pages):
- Be a member of the site
- Give STE your read-write API key
- Have regular permissions to create or edit the page in a web browser (configurable in site manager)
- Have API permissions to create or edit the page using the API (configurable in site manager)
To import (read pages):
- Be a member of the site
- Give STE your read-write API key or your read-only API key
- Have regular permissions to view the page in a web browser (configurable in site manager)
- Have API permission to read the page using the API (configurable in site manager)
Here is a table that outlines the difference between a read-write and read-only API key:
| API key type | Import | Export | Preview | Rename pages | Tag pages |
|---|---|---|---|---|---|
| No key entered | No | No | No | No | No |
| Read-Only key | Yes | No | No | No | No |
| Read-Write key | Yes | Yes | Yes | Yes | Yes |
Secondary uses of the API
In the background, STE uses the Wikidot API for the following tasks:
- Install extensions from the extension gallery
- Send usage statistics (if you have opted to send them)
- Check for software updates
All of these secondary tasks do not require you to enter your API key into STE - they use a separate, special-purpose Wikidot account for the task instead. Therefore:
| API key type | Install extensions | Send usage statistics | Check for updates |
|---|---|---|---|
| No key entered | Yes | Yes | Yes |
| Read-Only key | Yes | Yes | Yes |
| Read-Write key | Yes | Yes | Yes |
Developing with the Wikidot API
If you wish to use the Wikidot API in your own applications, you should become a member of the Wikidot Developer's Website and start discussing your ideas on the developer's forum.
Useful links: