Significant updates made in Tiki27, particularly to support Internet of Things (IoT) deployments, enhancing and adding support for:

• Trackers
• File galleries

A short summary of the use of the API for IoT deployment can be found on the next page with more detailed information available here.

A self-documented REST API is available since Tiki 24. This new feature is exposing the most commonly used elements of the system, notably:

• Categories
• Comments
• Groups
• Search
• Trackers
• Translation
• Users
• and Wiki

To start using Tiki API, you may need to refer to this documentation which details its endpoints.

.htaccess file must be enabled to make the /api/ URL work, which is standard practice to have SEFURLs.

Enable the preference auth_api_tokens via the admin page.

 Enable API access

In the Control Panel, the screenshot below shows how to enable auth_api_tokens labeled as API access:

• Check the box "API access"
• Click "Apply" to save your choice.

Enable API access

The Documentation is embedded in Tiki. See /api/ on your target Tiki 24+ installation for an OpenAPI 3.0 documentation of the API.

 Documentation page

For example, let's assume that your Tiki 24+ instance is installed on https://example.org, then the page under https://example.org/api/ should look alike:

API Documentation page

Example: Let's GET the API version

GET/version Request

Assuming example.org has API feature enabled, this code snippet,

Copy to clipboard

$ curl --request GET 'http://example.org/api/version'

Should return the following output as reponse:

Copy to clipboard

{
  "version": "24.1vcs"
}

See GET/version reference in documentation.

API requests should be authenticated with a token created by Tiki admin (via Admin -> Security tab). Each token gives their owner access with one and only one Tiki user. Permissions configuration is then based on that Tiki user's groups.

Authorization: Bearer TOKEN

Tokens can be created in two ways:

Using Tiki as OAuth 2.0 server or Create a user token

OAuth 2 provides authorization flows for third-party applications.

Authorization flow can be:

CRUD operations(Create, Read, Update and Delete) are available for Category, Comments, Groups, Trackers/Fields/Items, Users and Wiki pages.
The endpoints include:

Major items in wishlist for next versions of the API:

See all the references in the documentation.
Example Tracker API usage with JavaScript here https://dev.tiki.org/API-Access-Example.

Tiki's services live in lib/core/Services/. One can extrapolate the service URL from the file names and the names of the classes in the Controller.php files.
This only works if you have activated SEFURL feature.
Example:
For accessing information which is also available from searches in the Tiki site, the class is action_lookup() in file lib/core/Services/Search/Controller.php.
The path on tiki.org is: https://tiki.org/tiki-search-lookup
To refine the search, the arguments are the same as for https://doc.tiki.org/PluginList-filter-control-block
For example, in order to access the 45 first items from tracker 22, the syntax would be:
https://tiki.org/tiki-search-lookup?filter~type=trackeritem&filter~tracker_id=22&maxRecords=45

This works fine if called as ajax services from a page on the same Tiki.
If done from outside Tiki from another online server, only data visible for anonymous user (not logged in) will be shown.
In order to access data which is not visible to anonymous user, you may want to have a look at https://doc.tiki.org/Token-Access.

Where you can find more specific information and samples for the different controllers

• API Tracker

• service URL
• URL arguments