The attached document helps you setup an integration between Power BI and Qmarkets REST API.


Step 1: Authentication

  • For the Power BI authentication method, we will be using an API Key. Ask Qmarkets’ support to setup and access point using an API key and send you the generated key.


A note regarding Subsystems

  • If your system has multiple subsystems and the default landing page leads to “System Overview”, you will need to add the “subsystem_id” parameter as shown in the examples. If this is not the case for your setup, ignore this parameter.


Step 3: Setup data source

  • To retrieve data, you need to setup a new data source. This can be done by clicking the “Get Data” button. Select the “Web” option to setup the API connection.

    A screenshot of a computer Description automatically generated


 

Step 4: Setting up connection

  1. Select "Advanced" mode. 
  2. Type your domain name and the common API path "/api/v3/external" in the first URL section. 
  3. Enter the appropriate endpoint you wish to contact in the second URL section. For a list of possible endpoints, refer to the "Qmarkets API v3 User Manual" paper. The user list is being retrieved in the example below. 
  4. As previously stated, pass the required subsystem id in the second URL section if there isn't a default landing page set up. Subsystem ids can be found in the URL of each subsystem on your self-admin > subsystems page. 
  5. Add "Authorization" to the HTTP request parameters and enter your API key, which Qmarkets provided you, in the value (to the right).
  6. Click “Ok” when done.



Step 5: Handling response

  • Successful calls will be returned with the first column “Code” having "200" as a value.
  • To extract the data inside “data.data” column, do the following:
  1. Click the icon next to right of the “data.data” column title
  2. Select “Expand to New Rows”
  3. Now click the same icon again, this time there will be a new popup with a list of fields inside the data array:
  4. Click the “Close & Apply” button
  5. You can now start building your report with the data received