A data API key provides authentication for your app to interact securely with generated data APIs. If you create a data API key using the instructions in the Ask or Engineer page, NexusOne automatically generates a unique API key. This guide explains how you can manually create a data API key. Regardless of whatever approach you use, your app must include this key in the header of each HTTP request.Documentation Index
Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
- Appropriate permission:
nx1_askornx1_engineer - An existing domain created using DataHub
- A previously ingested dataset within a DataHub domain
Create a data API key
To authenticate with a data API, you need a data API key.- Log in to NexusOne.
- On the NexusOne homepage, click Connect.
- On the top navigation bar, hover your mouse over Connect and then select API Keys.
- Click the plus
+icon in the top right corner of the Data API Keys page. - Select an existing data API.
- Add a brief description for the key. This is optional.
- Add the number of days the key should be valid for. The minimum is one day.
- Click Create to generate the new API key.
Additional resources
- For an overview of the Connect feature, refer to Connect Overview.
- For more information about the Ask API, refer to Create an Ask API.
- For more information about the Engineer API, refer to Create an Engineer API.
- For more information about roles or permissions, refer to Govern Overview.