Client API Introduction
API Capabilities
INFINITI Prime’s API provides a robust solution for integrating our software into other systems. Due to the variety of features available, the API is broken down into two main functional areas: Standard API and Extended API. Companies use our API for things like data retrieval, data updates, and content integration. One of the most popular ways our API is used is to communicate changes in user information between systems. The INFINITI API uses REST API and HTTP Protocol
Connect your data & streamline your systems
The INFINITI Client API may be used to manage Users, User Groups and Assignments in the INFINITI platform.
Use the INFINITI Client API to manage Users, User Groups, and Assignments between the INFINITI platform and your other systems.
The Client API focuses on three main areas: Users, User Groups, and Assignments. It makes data retrieval, updating, creating, or deleting these areas as easy as possible.
The API can do things like automatically create a user in INFINITI when one has been created in your HR platforms OR make assignments with automatic notifications directly from your driver management platform.
The INFINITI Client API reference document can be found INFINITI Client API.
INFINITI receives over 1,000,000 API calls per month streamlining our training management system for any platform that wants to leverage its power.
Getting started with INFINITI’s API
Steps to utilizing the INFINITI API
1
What is an API?
An API, short for Application Programming Interface, is a software-to-software interface. APIs provide a secure and standardized way for applications to work with each other and deliver the information or functionality requested without user intervention.
In building applications, an API simplifies programming by abstracting the underlying implementation and only exposing objects or actions the developer needs. While a graphical interface for an email client might provide a user with a button that performs all the steps for fetching and highlighting new emails, an API for file input/output might give the developer a function that copies a file from one location to another without requiring that the developer understand the file system operations occurring behind the scenes.
2
How do APIs work?
APIs are sets of definitions and protocols that allow software components to talk and interact with each other using a simple set of commands. Acting as messengers, APIs deliver one application’s request to another and return a response in real time.
This documentation outlines the Client API for INFINITI platform. Provided are HTTP methods (GET, PUT, POST, DELETE) and GraphQL style queries. All GraphQL queries can return as little or many fields desired. Examples are provided with mock data to show the usability of the Client API.
3
API Examples
Without searching an API marketplace, or even knowing much about APIs, you’ve probably heard of a few. Below we’ll look more closely at several examples so you can understand what information and functionality is available through them.
This document contains links to examples and additional notes, all examples have been executed using Postman (https://www.postman.com/). Postman is a collaboration platform for API development. INFINITI does not provide support for Postman, it is a tool INFINITI uses to test and document the Client API.
4
Our API
The INFINITI Client API may be used to manage Users, User Groups and Assignments in the INFINITI platform.
INFINITI Client API reference document can be found here – INFINITI Client API.
Remember replace AuthKeyi3 with your key. All the examples in this documentation use the INFINITI UAT (Testing) URL – https://iwfclassroom-ext-api-uat.infinit-i.net/api/. For PRODUCTION integrations the PROD URL is needed – https://iwfclassroom-ext-api.infinit-i.net/api/. Also Auth Keys for the UAT environment are not valid for the PROD environment, an Auth Key for the PRODUCTION environment is needed for PRODUCTION integrations. Contact customer support to obtain an Auth Key for your PRODUCTION or UAT environment.
