API

Since Tiki24 an API has been available, leveraging swagger-api/swagger-ui

See it in action here: https://doc.tiki.org/api/

First commit: https://gitlab.com/tikiwiki/tiki/-/merge_requests/1028

Tiki 27+

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

• Trackers
• File galleries

The schematic below illustrates a generic IoT system with Tiki at its centre, where the left-hand side shows the different types of field deployed devices and their communications, and the right-hand side segments the different types of Tiki user that can each be supported with various types of reporting and analysis:

More information on the use of the API for IoT deployment can be found here with:

• details about example software for field deployed devices that automates the upload of data to Tiki using the API, and how
• customised reporting and analysis can be configured with, for example, automated notification emails for sensed alarm conditions.

Tiki 24+

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.

Requirements

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

Getting Started

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

Documentation

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.

Authorization

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.0 Server

OAuth 2 provides authorization flows for third-party applications.

Authorization flow can be:

Tiki Restful API Coverage

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.

Pre-Tiki 24 notes

Aliases

• service URL
• URL arguments