Aloha POS

Aloha POS is NCR Voyix's restaurant point-of-sale platform, used by restaurants to manage menu items, orders, payments, and third-party integrations across one or many locations. The Aloha POS connector is a source-only ELT connector that authenticates through NCR's OAuth2 platform and extracts data from Aloha POS APIs — including field definitions and item attributes — as scheduled, full-refresh feeds.

Power end-to-end data operations for your Aloha POS API with Nexla. Our bi-directional Aloha POS connector is purpose-built for Aloha POS, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Aloha POS or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Aloha POS workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

The Aloha POS connector authenticates via NCR Voyix's OAuth2 platform using a 3-legged authorization flow. Before creating an Aloha POS credential in Nexla, gather the following from your NCR Voyix developer account:

1. Register for an account on the NCR Voyix Developer Experience portal, which provides access to NCR's API explorer, documentation, and application management for Aloha POS APIs.

2. Create an application in the developer portal to obtain an OAuth2 Client ID and Client Secret. These identify your integration when requesting authorization from NCR's OAuth2 platform.

3. Note the OAuth2 scopes your application is granted. The Aloha POS connector requests the read write scopes by default.

4. Confirm the domains used by your NCR Voyix environment:

   • Authentication Server Domain — the NCR OAuth2 server that issues tokens (default: https://developer.ncrvoyix.com).

   • API Domain — the NCR API host that serves Aloha POS data (default: api.ncrvoyix.com).

Treat the Client Secret as a sensitive secret and store it securely. For details about Aloha POS data structures and integration concepts, see the Aloha POS documentation on NCR Voyix Docs and the NCR Voyix Developer Experience portal.

Authenticate

Credentials required

Authenticate via NCR's OAuth2 platform.

Field	Required	Secret	Description
Authentication Server Domain	Yes	No	e.g., https://developer.ncrvoyix.com
API Domain	Yes	No	e.g., https://api.ncrvoyix.com
Client ID	Yes	No	Unique identifier for your application when requesting OAuth2.0 authentication
Client Secret	Yes	Yes	Confidential key used to authenticate your application with the OAuth2.0 provider
Scopes	Yes	No	e.g., read write

Create a credential in Nexla

1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

   Resource descriptions are recommended but are not required. Use them to identify the NCR Voyix environment or Aloha POS deployment represented by this credential.

3. Enter the NCR OAuth2 server domain in the Authentication Server Domain field. The default value is https://developer.ncrvoyix.com. Nexla directs the OAuth2 authorization and token requests to this domain.

4. Enter the NCR API host in the API Domain field. The default value is api.ncrvoyix.com. Nexla constructs Aloha POS API request URLs from this domain when ingesting feeds.

5. Enter the OAuth2 Client ID of your NCR application in the Client ID field, and enter the corresponding secret in the Client Secret field. These values were obtained in Prerequisites and authenticate your application with NCR's OAuth2 platform.

6. Enter the OAuth2 scopes to request in the Scopes field. The default value is read write.

7. Complete the OAuth2 authorization flow. This connector uses a 3-legged OAuth2 exchange: Nexla redirects to NCR's authorization page, where you approve access, and Nexla then securely stores and automatically refreshes the resulting access and refresh tokens.

8. Click the Save button at the bottom of the overlay. Nexla verifies the credential by fetching field definitions from the configured API domain. The newly added credential will now appear in a tile on the Authenticate screen during data source creation and can be selected for use with Aloha POS flows.

Use as a data source

How This Connector Works

The Aloha POS connector is a source-only ELT connector. Rather than building requests from scratch, you select from the Aloha POS resources exposed by the connector, and Nexla ingests each selected resource as its own feed.

• Discovery: When you create the source, Nexla presents the Aloha POS resource types available for ingestion, and can query the Aloha POS API to list available objects such as field definitions.

• Full refresh: Feeds are ingested using a full-refresh strategy, so every run reads the complete current set of records for the selected resource. The id field is used as the primary key to identify records within each feed.

• Scheduled ingestion: Each feed runs on the schedule configured for the source, keeping downstream Nexsets up to date with the Aloha POS data.

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, click the New Data Flow button, select the ELT flow type, and click Create.

2. Select the Aloha POS connector tile from the list of available connectors. Then, select the credential that will be used to connect to Aloha POS and click Next; or, create a new Aloha POS credential for use in this flow. The credential's API Domain determines which NCR environment the feeds read from.

Endpoint templates

The Aloha POS resources available from this connector are listed in the expandable sections below. Click on a resource to view details and configuration guidance.

Available Aloha POS Resources

Static list of available resource types in Aloha POS. This discovery endpoint presents the catalog of Aloha POS resources that can be selected for ingestion when configuring the source.

• The following resource types are available for selection:

  • Field Definitions
  • Item Attributes
  • Create Consumer
  • Delivery Fee Settings
• No additional configuration is required for discovery — select the resource type you want to ingest, and configure any parameters required by that resource.

Aloha POS Feed Loader

Generic feed loader for Aloha POS APIs based on the selected resource. Use this feed to ingest any Aloha POS API resource by specifying its endpoint path, optional query parameters, and the path to the records in the response.

• Select the sync strategy in the Data Refresh Type field. Full Refresh is the available option — each run reads the complete current set of records for the resource.
• Enter the Aloha POS API endpoint path in the Endpoint Path field (e.g., field_definitions). Nexla appends this path to the credential's API Domain when fetching data.
• Optionally, enter a query string in the Query Parameters field to refine the request (e.g., pageSize=100).
• Enter the JSONPath expression that locates the records within the API response in the JSONPath to Data field. The default value is $.fields[*].
• Select the field used for record deduplication in the Primary Key field. The default value is id.

The feed loader issues GET requests to the configured Aloha POS endpoint and parses the JSON response using the configured data path. For information about available Aloha POS resources and their data structures, see the Aloha POS documentation.

List Field Definitions

Fetches field definitions from Aloha POS. Field definitions describe the data elements configured in the Aloha POS system, such as items, categories, and related configuration records.

• No additional configuration is required. The feed issues a GET request to the field_definitions endpoint on the credential's API Domain and reads the records from the $.fields[*] path of the response.

For details about Aloha POS field definitions and how they are used in integrations, see the Aloha POS integrations documentation.

Item Attributes

Fetches item attributes from Aloha POS. Item attributes carry descriptive properties for the menu items configured in the Aloha POS item database.

• Enter the ID of the group for which to fetch item attributes in the Group ID field. This field is required — the feed retrieves the item attributes belonging to the specified group.
• The feed issues a GET request to the item-attributes endpoint on the credential's API Domain, filtered by the configured group, and reads records from the $.items[*] path of the response.

Schedule and Activate

• Use the default sync schedule or adjust the schedule in the source settings before activating the flow. On each run, the configured feed is full-refreshed from the Aloha POS API.

Once all of the relevant settings have been configured, save the new Aloha POS data source. Nexla will begin ingesting data from the configured feeds on the set schedule and will organize any data that it finds into one or more Nexsets.