Introduction

The API has been developed to allow for simple scripting of tasks that interact with the core WIODE system. It uses key-based authentication to verify the connection to the server and returns JSON or raw data based on the type of request/command.

Generating Keys

Keys can be generated using the system control panel under the "API Keys" section. Simply generate a new key, provide any notes to help with identifying the key's usage, and the system stores the key for usage by the API.

Working With the API

The API works withthe following modules to return or modify data within the system:

Projects »

Retrieving and modifying the projects in the system.

Structure »

File manager and indexing.

Object »

Managing files and folders.

History »

Accessing previously saved versions of modified files.

Users »

Retrieving and managing users and user data.