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 OfiReach out to your Customer Success Manager if you're interested in this module.

What is API?

An Application Programming Interface (API) is a software intermediary that allows two applications to talk. This "conversation" 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. 

NOTEOfie Profile Pic: KaiNexus API is not SCIM or SCIM 2.0 compliant. 

What IT effort is required to set up API? 

When you purchase the API Module, you receive access to KaiNexus API endpoints. An API endpoint is the end of an API connection that allows you to retrieve and send data to KaiNexus.

However, it's important to note that KaiNexus currently does not offer pre-built API integrations with other software.

This means that your organization will need to establish connections between KaiNexus and other platforms, which requires a lot of effort from your IT team.

The developer documentation on this support site primarily focuses on accessing KaiNexus's API endpoints and making calls to various API types. We do not provide guides on establishing connections with other platforms. Therefore, your IT team should know how to build API integrations to utilize the KaiNexus API effectively. 

Types of API Calls

The API Module supports API calls for:

Item APIs

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

Customers use an 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.

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

Customers use an Item Update API when they are updating Items to and from their IT systems. Much of their work involves bringing in their IT team, so communicating updates to and from their IT ticketing system is vital.

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. 

Customers use an 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 APIs

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

We see a lot of our larger organizations 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 administrators a lot of time with user management in KaiNexus. 

Network APIs

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 synchronize the Location between KaiNexus and another software application. 

Chart APIs

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

Some customers automatically feed chart data into KaiNexus via a Chart Update API from their manufacturing intelligence systems. These metrics automatically update on team boards to help show team members their progress toward their goals.

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

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

Attribute Value APIs

An Attribute Value API helps you automate the creation, upkeep, and removal of Attribute Values to save maintenance time. 

Customers utilize Attribute Value API when they need to frequently update Attribute Values.

Impact Value APIs

An Impact Value API helps you automate the creation, upkeep, and removal of Impact Values to save maintenance time.

Impact Values are the additional classifications within an Impact Type. For example, your organization might have a Time Savings Impact. Within that Impact, there could be Engineer Time Savings, IT Time Savings, and more. These additional variations are Impact Values.

Customers often utilize Impact Value API when they want to automate the upkeep of their Impact Values. 

Next in the series:

After the API Module has been turned on for your organization, you can start with KaiNexus API. We recommend reading the two articles below for an overview of how to set up KaiNexus API.