Skip to main content

API Token Generation

AdvaPACS provides an API endpoint that generates secure eUnity launch URLs. This allows external applications such as RIS, EMR, patient portals, and custom integrations to open studies directly in eUnity without requiring users to manually search for studies.

The API validates the request, generates a temporary launch token, and returns a URL that can be opened in any supported web browser.

Use this endpoint when:

  • Launching eUnity from a RIS or EMR
  • Opening studies from a patient portal
  • Integrating eUnity into a third-party application
  • Providing single-click access to imaging studies

Authentication

Requests to the eUnity Launch API must be authenticated using an AdvaPACS API key. The API key must have permission to generate eUnity launch tokens. When creating or configuring the API key, ensure the Generate eUnity Token permission is enabled.

Include the API key credentials in the Authorization header using the following format:

Authorization: ID=<Access Key ID>,Secret=<Access Key Secret>

Example:

Authorization: ID=991004a2dfb04faead9e30e0eb66e186,Secret=XzzxHuSfPm76PVNSd+v1Sk69yb+YGtDlc

Keep the access key secret secure. It should only be stored in trusted backend systems and should not be exposed in client-side applications, browser code, or public repositories.

API Request

The eUnity Launch API allows studies to be launched using either a combination of Patient ID and Accession Number values, or directly using one or more Study Instance UIDs. Requests must be submitted as JSON using an HTTP POST request to:

https://<region>.api.integration.advapacs.com/viewer/launch

To launch via a combination of Patient ID and Accession Number(s):

{
"viewer": "eunity",
"patientId": "ABC123",
"accessionNumber": ["1", "2", "3"],
"username": "example.user"
}

To launch via Study Instance UID(s):

{
"viewer": "eunity",
"studyInstanceUid": ["1.2.3"],
"username": "example.user"
}

Note: The username must be a valid AdvaPACS username with permission to access eUnity.

API Response

If the request is successful, the API returns a JSON object containing a secure eUnity launch URL.

{
"url": "https://<region>.eunity.advapacs.com/e/viewer?aki=<token>"
}

Open the returned URL in a web browser to launch eUnity with the requested study or studies loaded.