Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Zen Section
id833529148

Getting Started

Info
titleILLiad Integration Workflows

See the ILLiad Integration document for more information on expected workflows with external systems. The document covers scenarios of both ILLiad-born and external-born requests and expected API calls in each scenario.

Generating an API Key

You will first need to generate an API Key for your application and create an entry in the WebPlatformConfig table in the ILLiad Customization Manager. An API Key is required for all secured methods. See Configuring the ILLiad Web Platform for more information.

Each application accessing the Web Platform should have its own unique API Key. If for some reason it becomes apparent that an individual application has been compromised, an individual API Key can be deauthorized from the Customization Manager by removing the WebPlatform config records. If all applications use the same APIKey access to all will be affected. To prevent unauthorized distribution of an API Key, you should only make requests to the ILLiad Web Platform using server-side scripting such as ASP or PHP. Client-side scripting (like Javascript) will expose your API Key which can lead to ill effects. Protect your API keys!

Info

For brevity, the API Key used in examples in this documentation will be ABC123. Typically the key will be a longer alphanumeric string that looks more like 71ed0900-97aa-4157-ad9f-e74bcfa5e709.

Versions and Updates

We will introduce API changes when necessary/possible, and update the API version number (i.e. v1) when a breaking change is made. Additions to the API does not necessarily mean the API version will change but changes will always result in the Web Platform version number being incremented. For documentation purposes, each request will indicate the minimum Web Platform version required.

If the version is not provided in the Accept header it is assumed that the most recent version of the API should be used. To explicitly request a response from a specific API version, the version should be specified in the Accept HTTP header.

Code Block
linenumberstrue
languagexml
GET /ILLiadWebPlatform/SystemInfo/PlatformVersion HTTP/1.1
Host: your.illiad.edu
Accept: application/json; version=1

Some requests may be introduced to newer versions of the API and may not be backward compatible. A minimum API and Web Platform version will be noted in the documentation.

Zen Section
id833580949

Making Requests

Authentication

Warning

You must use SSL (HTTPS instead of HTTP) to access the ILLiad Web Platform.

To authenticate with the API, you must supply an ApiKey HTTP Header when making a request to a secured action. For example:

Code Block
linenumberstrue
languagexml
GET /ILLiadWebPlatform/SystemInfo/SecurePlatformVersion HTTP/1.1
Host: your.illiad.edu
ApiKey: ABC123
Accept: application/json; version=1

Some requests are considered public and will not require an API Key. The authorization for each action will be noted in documentation as either secured or public.

...