Developer Center

Here you will find some of our publicly available APIs so you can integrate with us easily

> $ curl https://api.icaremanager.com/v1/connect Hello World!
> $ curl https://api.icaremanager.com/v1/disposition Don't like information silos

We are developer and integration friendly.

Training Module

iCareManager provides a sophisticated module to keep track of staff training. The module allows customers to define and enforce policies that ensure that all staff members are properly trained at all times even as their jobs and responsibilities change over time.

In terms of capabilities, iCareManager track training, manages classrooms and registrations, sign in/out sheets, quizzes, and person/individual centered training of staff. It stores links to various types of training material such as videos and documents. However, it does not deliver training content in a timed presentation mode. For that capability it integrates with external systems and provides APIs so these systems can integrate with iCareManager.

There are a few steps that must be completed by both, customers and training system providers, to fully integrate and ensure a seamless experience to the end user.

Step # Completed By Details
1 Customers

iCareManager customers must add links inside the “Training Material” tab of each training so the staff can click on the link and be taken to the correct training. The link to the training can be in any format.

Customer must ensure that the link is correct and takes the staff member to the corresponding training module in the training system.

2 iCareManager

When the user clicks on the link stored inside the training material, iCareManager appends a dynamically generated JWT (JSON Web Token) and passes it to the training system in query string. The JWT contains the user ID of the staff member and the training module ID.

3 Training Vendor

Once the training is completed, the training vendor will inform iCareManager of the final status of the training session by calling the Training API.

Note: Every call to the API must contain the JWT and the iCMAccessKeyID in http headers.

Authenticate

Obtain an iCM Access Key ID from the customer. Please protext this key.

Last updated 7/29/2020 4:39 PM

End Point
None
Training

Use this request to set the training status once it is completed. Every request must have the following two HTTP headers:

HTTP Headers

Authorization: Bearer JWT

ICMAccessKeyId: API Key Id

Payload

{ status: "[0|1]" }

0 if training is not completed, 1 if completed

Last updated 7/29/2020 4:39 PM

End Point
POST /v1/training/:status
Error Codes

iCareManager will not honor any request without a proper authorization header. It will also return error codes when a malformed request is made or if the system is not available.

Last updated 7/29/2020 4:39 PM

Error Codes
200
Successful completion of request with the provided payload
400 Bad request often due to malformed syntax.
401 Unauthorized request due to missing or invalid security token
404 Not Found - the requested URI is not found
403 Forbidden - security key was found but the request is not allowed due to permissions
500 Something went wrong on iCareManager's side.