Skip to main content

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.

The Connect feature provides programmatic access to ingested data and a single interface to access user-facing hosted apps on the NexusOne platform. It also lets you share datasets securely across NexusOne tenants using Gravitino data shares credentials.

​
Key features

Connect has the following key features:

​
What are data APIs and data API keys?

Data APIs are RESTful API endpoints used to interact with ingested data within the NexusOne platform. This interaction uses the NexusOne Ask or Engineer feature. A data API key provides authentication for your app to interact securely with generated data APIs. Fundamentally, the Ask or Engineer feature generates an SQL query from natural language. This query becomes a rule you can schedule in Apache Airflow to interact with your ingested data. However, if you want to programmatically interact with the rule so you can retrieve the latest processed data, you do that using a data API endpoint. Here is a use case where you can use NexusOne data APIs. Say, you want your app to access data in NexusOne programmatically and output the result in your custom dashboard. To achieve this, you can do the following:
  1. Using the NexusOne Ask feature, you can define a data insight rule that returns the top product sold every Friday in your organization.
  2. You can schedule the rule in Apache Airflow using NexusOne’s automatic reporting cycle, so it runs weekly and keeps the insight up to date.
  3. You can then create an Ask API for that rule. NexusOne generates a data API and a data API key from the Ask API.
  4. Your app can then send an HTTP request to the data API endpoint.
  5. When the data API endpoint returns a data insight response, your app consumes that response and feeds it into your organization’s custom dashboard.

​
Data-plane vs control-plane APIs

When you create an Ask API or Engineer API, NexusOne generates a data API and API key you can use to consume data insights or transformation results that already exist. This data API is data-facing:
  • It’s tied to the specific rule you defined earlier.
  • You call it to fetch data insights via Ask or execute data transformation via Engineer.
  • It’s meant for consumption, not for creating or modifying new rules.
On the other hand, the control-plane APIs are configuration APIs:
  • You can find them in the API reference page.
  • They let you programmatically create, modify, or delete rules. These are the same actions you’d do in the NexusOne portal.

​
What are Gravitino data shares credentials?

Gravitino centrally manages Iceberg metadata, such as schemas, snapshots, and partitions. This management is helpful in the following ways:
  • You want NexusOne apps such as Spark and Trino to communicate with this metadata.
  • You don’t want to individually manage access from these apps, NexusOne, to a catalog such as Hive Metastore or PostgreSQL via JDBC.
These Gravitino features are within the NexusOne portal, a portal deployed using Kubernetes, and represented as a tenant. As a customer, you can deploy a provider and consumer tenant, each containing a NexusOne portal. Data shares credentials uses Gravitino to work across tenants and allows you to securely share datasets. Here is a use case where you’ll need a Gravitino data shares credential. Say, you need a user in your consumer tenant to access a dataset that exists in your provider tenant. To achieve this, you can do the following:
  1. Purchase NexusOne and deploy a provider tenant and a consumer tenant.
  2. Ingest a dataset into your provider tenant.
  3. Create a Gravitino data shares credential in that provider tenant for that dataset.
  4. A user in the consumer tenant can use that credential to create an Iceberg REST catalog and access the shared dataset.

​
Use cases

These examples show how different industries and teams can use NexusOne’s Connect capabilities:
  • Retail: Expose weekly top-selling products and show the results in your organization’s custom dashboard.
  • Financial services: Use the Engineer API to process transaction data, identify suspicious activity, and calculate compliance metrics. You can then create a data API for the compliance metrics data so your internal risk dashboard can call the data API and use its response to show the latest fraud alerts and compliance status.
  • Data platform teams: Share datasets securely across provider and consumer tenants using Gravitino data shares credentials.

​
Additional resources

For more information, refer to the following: