Getting Started - Mitinet API

The integration of Mitinet services into an existing ILS will allow easy access of the Mitinet suite of tools within the ILS. There will be API calls in place which the Partner’s Business System or ILS will need to call. There will also be some API calls which will need to be implemented at the Partner’s site/ILS for Mitinet to call. The Mitinet API is located at https://api.mitinet.com/... for the Mitinet production environment.

This Getting Started document describes what API calls are required to implement the integration and an overview of the process. Detailed documentation for all of the calls and testing tools are provided on the API Documentation page.

Authentication

All API calls must include a Basic Authorization header using the basic access authentication scheme, encoded in Base64.

Send Basic [space] and then your Base64-encoded username:password in an Authorization http header. The credentials to encode will be provided upon signing up to be a Mitinet Integration Partner.

Example Header:
Authorization: Basic 12345abcdef

Customer Linking and Licensing

Customers which are licensed to use Mitinet Tools in a Partner’s ILS system must be linked to a Mitinet customer and license. This process is initiated in the Partner’s Business system. Once linked, the Partner’s Business System and ILS will be able to communicate with Mitinet’s System and Processes by using just the Partner’s unique ID for the customer since Mitinet will have that ID linked to a Mitinet customer. The Relevant API calls are listed below.

Customer Link Request (POST)

Called when a customer’s license is first created in the Partner’s Business System. The data passed to the API includes details for the district and its schools. It also includes the license expiration date.

After the link has been requested, Mitinet personnel will then match the Partner’s customer to an existing Mitinet customer or create a new one. An appropriate license for the customer will then be created in the Mitinet system.

Customer License (PUT)

Called from within the Partner’s Business System anytime the customer’s license has been updated with a new expiration date. Of course, it would not need to be called before the POST Customer Link Request was called for the customer.