Introduction to API

The API Module

Use the API Module to create, update, delete, and export data from KaiNexus into JSON and .XLSX format.

Trim OfiREQUIRED: Reach out to your Customer Success Manager to enable the API Module.

What is API?

An Application Programming Interface (API) is a software intermediary allowing two applications to talk. This "talk" is called a "call." 

How can API help me?

The API Module connects KaiNexus to other integral areas of your business.

Whether you run a ticketing system to track maintenance requests, organize initiatives in project management software, or run advanced metrics in an intelligence system, there can sometimes be a disconnect between your work in KaiNexus and other software. 

API helps your systems speak to each other and share information, unifying workflows instead of keeping them separate. 

Ofie Profile PicNote: KaiNexus API is not SCIM or SCIM 2.0 compliant. 

Types of API Calls

The API Module supports API calls for Items, Network Locations, People, and Charts. Below are the types of API calls we offer and examples of how customers utilize them

Item Export API

An Item Export API call will export the information for an individual Item or many Items in a List. This helps you take information generated in KaiNexus and export it to other software platforms. 

For example, customers use Item Export API when they are planning to connect to a project management system for higher-capacity strategic projects. Any idea that needs advanced project management features gets exported, and when it's completed, the resolution will be updated in KaiNexus.

Item Update API

An Item Update API call lets you update the information for many Items simultaneously. This not only streamlines the process to update Items in the system, but it also helps you update information in KaiNexus based on information from other systems.  

For example, customers use Item Update API when they are updating items to and from their IT systems. Many of their improvements involve bringing in their IT team, so communicating updates to and from their IT ticketing system is vital.

Item Creation API

An Item Creation API call lets you create one or multiple new Items in the system. This is especially useful when you generate new work or ideas outside of KaiNexus and want to bring them into KaiNexus for tracking and reporting. 

For example, customers use Item Creation API when they want to add Items to KaiNexus from their maintenance system, allowing KaiNexus users to view up-to-date information on maintenance requests. 

People API

A People API call lets you create, update, or inactivate users in the system.

We see a lot of our larger organization utilizing our People API as a way to automate the process of adding new user accounts to the system when a new employee is hired, inactivating accounts when staff leaves the organization, or updating user profiles when key information changes are made in the organization's records. 

This saves admins a lot of time with user management in KaiNexus. 

Network API

A Network API call lets you create, update, or delete Network Locations in the system.

This helps you make updates to your Network, especially when you want to sync the Location between KaiNexus and another software application. 

Chart Update API

A Chart Update API call lets you update a single Chart or multiple Charts within the system. 

A few customers are automatically feeding chart data into KaiNexus via the API from some manufacturing intelligence systems. These metrics automatically update on team boards to help show team members their progress toward their goal.

Chart Export API

A Chart Export API call lets you export a single Chart or multiple Charts from the system.

Customers often utilize Chart Export API to pull data from Charts in KaiNexus and enter it into a business analytics system. 

Ofie Profile PicIf you want to use our API calls to automate information and make your work easier, reach out to your Customer Success Manager!

Next in the series:

Once your article has enabled the API Module, you can start with KaiNexus API. We recommend reading the two articles below for a summary of how our API works.