This section describes how to work with the various supported API integrations with third-party software. API Integration is setup and managed entirely in the web client. Also note that API integration can only be utilized in the web client and is not intended for use with the windows client.

Configure Director

The Q360 Director manages all inbound and outbound API traffic on a network and must be configured in order for any of the API integrations to work correctly.

Create a dedicated user ID for managing and authenticating integrations.

1. Go to Maintenance > User Maintenance.
2. In the User ID field, enter the user name. The recommendations is to use the ID Q360API.
3. In the User Type field, select Q360API. Both the User ID and the User Type be named Q360API.
4. Click the Save icon.

Configure the Director settings.

1. Go to Maintenance > API Configuration > Director tab
2. Enter the following details:
   • Director URL: The URL https://example.com/Q360API/director.php, where example.com is the domain name for your instance.
   • User ID: The Q360API user ID created in the above section.
   • Password: The password for the Q360API user ID.

3. Click Save.
4. Click Test Service. If the setup is successful, the message “Director is configured correctly.” displays.

Useful tips

When setting up Director, ensure the following:

• The URL contains https and not http
• The correct production or test instance is being used
• If an error message displays when testing Director (Test Director button), try resetting the password for the Q360API user. To do this, go to Maintenance > User Maintenance, open the Q360API user, click the extended menu icon, then select Change Password.

API Developers

For developers needing to work the Q360 API code directly, refer to the embedded web client documentation at https://example.com/Q360API/Documentation, where example.com is the domain for your web client instance.