« BACK

Back to Basics: Ambra API

The Ambra API, or Application Programming Interface, is essentially a software intermediary that allows applications to talk to each other.  The Ambra API powers multiple integration workflows, and is very flexible when it comes to functionality. The Ambra API can be used to access parts of the Ambra product that are not surfaced in the user interface as well as for advanced account configurations. You can also use the API to bulk add information to the user interface, such as to add multiple users to an account or set anonymization rules across multiple namespaces.

The API can be accessed here: https://access.dicomgrid.com/api/v3

Once logged in you will reach this page:

api

There are two main components available for Ambra customers:

  1. The Public API, which acts as an index. It lists Ambra API commands that can be run and the necessary information you will need to run them.
  2. The API tester is where API calls can be run. It provides a structured way to pass commands to the Ambra servers.

The URL field is where you will enter the call you wish to run. The sid will populate automatically as long as you are logged in, but the other parameters necessary for the call will need to be entered manually:

api 2

If you are running a bulk call, you can enter multiple values, such as user emails for a bulk user add, you can enter them in the Multi-valued parameter.

api 3

Once you are ready to run the call you can scroll to the bottom of the page and hit “Submit”.

api 4

The result of the API call will appear at the top of the page, whether this is the information you were retrieving:

api 5

Or the status of the change you were trying to make through the API:

api 6

«
»
Mira Guha

About Mira Guha

Mira is a Senior Customer Success Analyst in Ambra's Denver office. She loves finding ways to make Ambra easier to navigate and understand for everyone who uses it! When she is not behind a computer, she can be found singing, going for a run, or playing with a golden retriever.

Medical Imaging Software Buyer's Guide

Leave a comment

Your email address will not be published. Required fields are marked *