Getting Started

This guide will walk you through the steps to create a device key and how to authenticate with the EON API.

The EON Product Cloud bridges the gap between the physical world and the digital one. In the physical world users are managing product items through digital devices like POS systems, scanners or label makers. EON uses the concept of a device to control access and permissions to the EON Product Cloud. This allows specific device restricted permissions based on their use case, reporting by device, and device management.

API Key RequestCreate DeviceData PermissionsInteraction FilteringAssociationsPoint of SaleClaim an ItemAuthentication

Device Creation (API Key request)

EON Product Cloud administrators can create and manage devices through their EON instance.

  1. After logging in, click on "Devices" in the left navigation menu. If your navigation is collapsed, click on the cog icon.
  2. Click the "Create Device" button near the top of the screen.
  3. Configure your device permissions

Create Device

  1. Name: A string value for your device
  2. Type: Determines usage and sets default values
    • Custom: Regular api key usage, e.g. data integrations, developer testing
    • Partner Mobile App: Keys used with the Eon Partner Access mobile app
    • Partner Mobile App (Association): Pre-selects associate/unassociate options
    • Partner Mobile App (POS): Pre-selects Point of Sale access option
  3. Description: A string value to describe your device to others.
  4. Metadata: A JSON object of fields to be included in the metadata field on any Interactions created by the device. Additionally, if the item_association_override_data key is specified, this field will not be included in Interaction metadata. Rather, any Items generated by the Device will have the internal JSON added to their override_data field.

Data Permissions

Data permissions grant access to read, create or update the following entities and schema.

  1. Products: Manage products or their custom data, translations, images or assets.
  2. Items: Manage items associated with a product.
  3. Interactions: Manage item interactions (events).
  4. Labels: Manage the physical or digital identifier for an item.

Interaction Filtering

Restrict Device read access to specific Interaction types; comma-separated list. If a given type is not specified in this list, it will be filtered out of API responses for this Device. This will not restrict this Device's ability to create Interactions. Leave blank to allow read-access to all Interaction types.

Associations

Control this device's access to the Associate and Unassociate API endpoints. This is a sub permission of Labels. It allows a device to un/associate a label from a QR code label or NFC tag. Both should be checked for label makers.

Point of Sale

  1. Point of Sale: Control this device's access to the Point of Sale tab in the EON Partners Access mobile app.
  2. Capture PII Data: Enables the customer email or identifier input field.

Claim an Item

Control this device's ability to claim and transfer ownership of Items. Control this device’s access to the claim endpoint. Once an item is claimed it can only be reclaimed with this endpoint. This should be selected for devices or applications that facilitate the transfer of ownership of an item.

  1. Click "Save"
  2. The API key has been provisioned and can now be used by the device, application or developer.
  3. Copy the key to your clipboard or send a secure email to a colleague.

Authentication

API authentication is done through an API key supplied in the request header. Use Device-Api-Key as the header key name. We recommend that the actual API key be stored as an environment variable. The key does not have an expiration. You can rotate your keys from the device management page in the Eon product cloud.

curl --location 'app.eongroup.co/api/v2/items/' \
--header 'Device-Api-Key: usKBElTd.Ju1**********KRMfGUJrtPsnKNT0F8w'