User Documentation
User Documentation
Breadcrumbs

Getting started

As a user of the HID Integration Service (HIS), you will receive:

  • Access to Docker images containing preinstalled agents required for on-premise deployment.

  • Access credentials to our cloud service, which hosts Access Integration Service (AIS) API.

This guide will walk you through the steps required to set up and start using the service.

Understand the platform

Go to the AIS overview to get additional information about AIS and its connections.

Prepare your accounts

To interact with the platform, you’ll need three types of accounts (provided during onboarding):

  • Tenant Administrator Account: Grants access to configure your tenant using the AIS API. We provide it with the TenantAdministrator role.

  • Agent Technical Account: Used by the PACS Agent to authenticate within HIS platform, in this case AIS. We provide it with the AgentInstance role.

  • API Technical Account: Used by your application to authenticate within HIS platform, in this case AIS API. We provide it with the TenantAdministrator role because the application can also do settings of the tenant. In case just operation of PACS is needed, PacsAdministrator role is sufficient.


Please check the Roles & Permissions section to see the permissions assigned to each default role.

accounts.drawio.svg


Set Up Your PACS System

  • Ensure your PACS system has its API enabled.

  • Create a PACS technical account for the agent to be able to connect to your PACS.

These steps are described for each supported PACS system here.

Register Your PACS in HIS

Use the Tenant Configuration API to register your PACS system in your tenant.

Configure Extension Fields (Optional)

If your integration requires custom fields, you can define extension fields in your tenant configuration.

Install and run the agent

  • Check the compatibility matrix and download the agent for your PACS from the SFTP server.

  • Run the agent in any Docker-compatible environment using:

    • The Agent Technical Account (to connect to AIS).

    • The PACS technical account (to connect the agent to your PACS system).

    • These steps are described for each supported PACS system here.

  • You can also find a video tutorial on how to connect an agent to the platform here.