Help & Support

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

user-icon

Register for an Account

After you register for an account, you'll receive a verification email which activates your account.

user-icon

Browse our Services

Explore our Services by clicking the Services link at the top of the page. Click the Service card "Explore API Documentation" to see an overview of the chosen Service. You must sign in to try out the API.

create-application

Create an Application

Click "My Apps" link on the navigation bar and click "Create App" to open Application creation form.

  • Name your application in the provided field and provide an optional description.
  • Choose Service(s) and select the Service(s) that you want to include in your application. Once you have them selected, click Add at the bottom of the page.
experiment

Experiment in UAT

After you've created your application, you can test drive the Service(s) with the UAT Credentials on the App Page.

  • You can either use the Auto-Generated Access Token or manually generate one using the Client ID and Client Secret for most Services.
  • Call the APIs using the Access Token in the UAT environment.
go-live

Go Live

After you've fully tested your app, you can promote your application by following the procedure below.

  • Click Go live from the kebab menu option on the app card.
  • After filling out your comments/reason, 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. Typically, approval takes less than 48 hours.
  • As soon as one or more API Products are approved, you'll be notified by email.
  • After approval, new Production credentials will be made available to you, and then you can validate your integration and call the API.
note-icon

NOTE:

If you're planning (or even considering) to "Go Live," contact us to discuss our requirements for access and integration so we can help get the process started and keep you moving along at your pace.