Skip to content
PineXQ Logo PineXQ Documentation

Web client - HUI

For visual access to the API we host a Website (HUI - Hyper Media UI) which renders API responses as a generic UI. HUI is not as convenient as a handcrafted UI but still very useful to understand the API and to do quick lookups.

Setup

Section titled “Setup”

The login page of HUI will request you to provide the entry point for the desired API (1).

HUI Login

To be able to access the PineXQ you also need to provide your API key for authentication.

  1. Click the settings button top right (2)
  2. Select “Sites” (3-1)
  3. Click the Add site button (3-2)
  4. Set the value Host to the host of the endpoint you want to call e.g. jobs.api.dev.data-cybernetics.cloud (3-3)
  5. Add a header by clicking the + icon next to Headers (3-4)
  6. Add a key value pair: (3-5)
    • Key : x-api-key
    • Value: your API key

Settings

This will send your API key to all requests to the specified host which uses it to authenticate you.