Introduction

Welcome to the AiFi developer documentation. This guide is your starting point for integrating with our platform.

We'll first walk you through the core setup steps required for any integration. Once your development environment is ready, you can proceed to the specific guide for the system you want to connect.

Getting started: Core setup

Before you can build a specific integration, every developer needs to complete these initial steps. Please follow them in order.

• Get access to a sandbox: Request and configure your dedicated testing environment.
• Authentication: Use your Authorization token in the harder.
• Download Postman Collection: Use the Postman collection to test your integrations.

Choose your integration guide

After you complete the core setup, you're ready to build. Choose the guide that matches what you want to integrate.

• POS Integration: Find instructions and best practices for connecting your Point of Sale (POS) system to sync product catalogs, manage transactions, and streamline store operations.

• Loyalty Integration: Learn how to connect your customer loyalty programs to identify shoppers, manage accounts, and apply rewards within the AiFi ecosystem.

• Third-Party Integrations: Use our general developer guide for connecting other hardware or software, such as smart coffee machines, vending machines, or other custom in-store experiences.

• Data Integrations: Instructions and best practices for connecting external Business Intelligence (BI) systems, data warehouses, and operational tools to the AiFi platform.