Skip to Main Content
Getting Started Hero image

Getting Started

Vendors, learn how to integrate with HCAI and review frequently asked PMS questions.

This page is useful for PMS Vendors who wish to integrate their software with HCAI.

What are the steps to integrate with HCAI?

  1. Complete the Non-Disclosure Agreement

    Every PMS Vendor must sign a non-disclosure agreement (NDA) stating that it will not share confidential information about HCAI to other parties. The document must be signed by an officer of the company who has signing authority.

    Click here to download the non-disclosure agreement (NDA). Once the NDA is completed and signed, either scan and email it to pmsvendorsupport@hcaiinfo.ca, or fax the form to 416-644-3139 and send an email to pmsvendorsupport@hcaiinfo.ca indicating that the form has been faxed.

    In your NDA email, include the email address and phone number for two contacts at your company, to facilitate future HCAI communications.

    Within 3-5 business days following receipt of the completed and signed NDA, the document will be processed and signed by HCAI Processing.

  2. Receive PMS Vendor Package

    After we receive your email and the NDA is processed, PMS Vendor Support will send a copy of the signed and approved document along with a secure link to download the latest version of the PMS Vendor Package.

What is in the package?

The PMS Vendor Package contains the PMS Integration Toolkit and other resources that may be helpful for integration with HCAI. Among these resources are samples of the messages that can be sent to and received from HCAI, documentation of the different interface functions, sample code, and data field and data type descriptions.

What is the PMS Integration Toolkit?

The HCAI PMS Integration Toolkit is a component built using the .NET 4.0 Framework. It provides a set of classes that PMS can use to integrate with HCAI. Although the Toolkit is recommended, its use is not mandatory in order to integrate with HCAI. A non-disclosure agreement must still be signed.

HCAI & Regulatory Changes

HCAI is an evolving system. As it matures, HCAI continues to implement changes which may include enhancements, optimizations, and regulatory changes imposed by the Financial Services Regulatory Authority of Ontario (FSRA). HCAI works closely with FSRA to implement these changes as soon as they are requested.

HCAI Integration interfaces are updated with each schema change. PMS Vendor Support sends communications to all PMS Vendors with announcements and information about any upcoming changes. PMS Vendors are also provided an updated Toolkit and given testing windows within a test environment. Please ensure your contact information is up-to-date with PMS Vendor Support to ensure you receive all HCAI communications.

Frequently asked questions

What are the software requirements for integrating with HCAI?

The PMS Integration Toolkit requires the Windows operating system. However, if PMS integration is implemented using web services and published schema, then there is no restriction on the operating system that can be used. A high speed internet connection is required.

Is there a permanent HCAI test environment?

A test environment will always be available for PMS Vendors to test their own enhancements or to test for specific changes.

Is there a restriction on the amount of data/batches a PMS user may send to HCAI?

Multiple batches and multiple requests are allowed.

How secure is the transmission of data to HCAI?

In alignment with industry standards, all data is encrypted using SSL encryption.

Are digital certificates required for integration with HCAI?

Digital certificates are not required for PMS integration. Authentication is based on a User ID and password.

PMS integration eLearning videos

View these handy video guides to learn more about PMS integration.

Introduction to integrating with HCAI

An introduction to the technical side of PMS integration.

The PMS Web Services Interface

Learn about integrating using the Web Services interface.

The PMS Toolkit API

Learn about integrating using the PMS Integration Toolkit API.

Review of sample programs – Part 1

A demo of the PMS integration interface and sample code illustrating document submission.

Review of sample programs – Part 2

A demo of the PMS integration interface, continued.