Integrations and API keys
Reference for Integrations and API keys in Wholechain Settings.
At a glance
| Item | Detail |
|---|---|
| Who can use it | Admins. Employees cannot enable third-party integrations. |
| Applies to | The whole account. |
| Where to find it | Organization Settings > Integrations, with the tabs Integrations and API keys. Open Settings with the gear icon at the bottom of the left-hand navigation bar or the Settings button on the Dashboard. |
| Prerequisite | An account with the provider, for provider integrations. |
Provider integrations
| Provider | Card description |
|---|---|
| iFoodDS | Connected Traceability, quality management, and food safety solutions for the entire supply chain. |
| ReposiTrak | Automated and secure supply chain data exchange for lot code and shipment information. |
| FoodLogiQ | Software suite provides a food supplier management software platform to help you align to brand and regulatory compliance. |
Each card has Learn More (opens the provider's website) and a toggle (off by default). Switching an integration on opens its configuration, which requires information for the account with that provider. Each receiving system defines its output specification; Wholechain provides configuration for mapping recorded data to it. Questions about customer discounts: support@wholechain.com.
All API Keys
| Element | Description |
|---|---|
| Generate New API Key | Opens a modal showing the key and instructing the user to copy it; it cannot be viewed again. |
| Table columns | Trade Partner, Digital link, Label, API Key, Created, Actions. Rows show the self Trade Partner, the key's last four characters, the created date, and a label when supplied. |
| Edit (three-dot menu) | Add or change a label; save or cancel from the actions menu. |
| Delete (three-dot menu) | Opens Delete API Key. Cancel, X, or clicking outside cancels. Confirming removes the row and shows a success message. |
These are account keys and have no partner-specific Digital Link entry. Complete the generate modal with Save after copying the key; the key is registered in the table when the modal is completed.
Digital Link URL
Displays the account's Wholechain Digital Link URL, which can be copied and shared with partners using compatible external traceability systems.
EPCIS keys
Table columns: Trade Partner, Label, Other System API Key, Other System Digital Link, Actions. Row Actions menu: Edit, New API key, Delete.
| Step | Action |
|---|---|
| 1 | Generate New EPCIS Key |
| 2 | Select a Trade Partner from those in the account (see Trade Partners). |
| 3 | Optionally enter a label. |
| 4 | Enter the other system's API key and Digital Link, if available. |
| 5 | Use the row's three-dot Actions menu and select New API key to generate the Wholechain API key. |
| 6 | Copy the key when shown; it cannot be viewed again. |
| 7 | Save the row. |
Later, the label and the other system's API key and Digital Link can be edited.
| Side | Must contain |
|---|---|
| Wholechain | The other system's API key and Digital Link |
| The other system | The Wholechain-generated API key and Wholechain Digital Link |
Rules
| Rule | Behavior |
|---|---|
| Keys shown once | A key cannot be viewed again after the modal. |
| Key replacement | Generating a replacement EPCIS key overrides the previous key, which loses its functionality. The new key is displayed once. |
| Two-sided setup | Systems exchange traceability events only after both sides contain the other's API key and Digital Link. |
| Deleting a key | Removes the row; this cannot be undone. |