Skip to main content

Relais Integration and the API

Configuring the API Connection​

You will first need to generate an API Key for your application and then create an entry in the WebPlatformConfig table in the ILLiad Customization Manager.

Generating an API Key​

You will need to generate a new key unique to the Relais integration. Atlas recommends that each application using the ILLiad API should be configured with its own API key so that the key can't be revoked in the event one of the integrations sharing the key is no longer used.

  1. Open the Customization Manager.
  2. Click New Record to create an entry in the ApiConfigtable.
  3. Enter your URL in the Base API URL field.
  4. Designate a Description to help easily identify the purpose of the key (e.g., Relais Integration).
  5. Fill out the External User ID Mapping field with ExternalUserId (name of a User field that already exists like SSN, UserInfo1, or Username).

For more details, see The ILLiad Web Platform API.

Configuring the Web Platform​

See **Configuring the ILLiad Web Platform**for step-by-step instructions.

Additional Considerations​

The value provided for the ExternalUserId will always override the value that the ExternalUserId is mapped to. E.g. If WebPlatformConfig is configured to have an APIKey with the ExternalUserId mapped to SSN, if SSN is provided and ExternalUserId is null or not provided, the SSN is set to null because ExternalUserId overrides the values provided for SSN. If SSN was set to 123 and ExternalUserId = 234, then SSN will be set to 234 for the same reason as the original example.