Help & Support

Kickstart your journey with our platform using the FAQ for quick answers and the User Guide for detailed tips!

user-icon

Register and Activate Your Account

First, register for an account. Once you verify your email, your account will be activated, giving you full access.

browse-services

Explore Our Services

To see what we offer, click the "Services" link at the top of the page. You can then click on a Service card, such as "Explore API Documentation," for an overview. Remember, you'll need to be signed in to try out any API.

create-application

Create an Application

Ready to build? Click "My Apps" in the navigation bar, then "Create App."

  • Name your application in the field provided (an optional description can also be added).
  • Choose the Service(s) you want to include in your application, then click "Add" at the bottom of the page.
experiment

Experiment in UAT (User Acceptance Testing)

Once your application is created, you can test drive your chosen Service(s) using the UAT Credentials found on your App Page.

  • You can use the auto-generated Access Token or manually generate one using the Client ID and Client Secret (available for most Services).
  • Use this Access Token to call the APIs within the UAT environment.
go-live

Go Live

After thoroughly testing your application, you can promote it to a live environment.

  • Click "Go live" from the options menu on your app card.
  • Fill out your comments/reason for going live, then click the "Go live" button at the bottom of the form.
  • Your request and app details will be sent to the CAIT product teams for review. Approval typically takes less than 48 hours.
  • You'll receive an email notification as soon as one or more API Products are approved.
  • Once approved, new Production credentials will be made available. You can then validate your integration and call the API in the live environment.
note-icon

Important Note:

If you're planning or even considering going live, please contact us to discuss our access and integration requirements. We're here to help you get started and ensure a smooth process.