Integration Use Case Template

This is a template for an application showcasing integration capabilities using Integration.app. The app is built with Next.js and demonstrates how to implement user authentication and integration token generation.

Prerequisites

• Node.js 18+ installed
• Integration.app workspace credentials (Workspace Key and Secret)

Setup

1. Clone the repository:

git clone <repository-url>
cd <repository-name>

2. Install dependencies:

npm install
# or
yarn install

3. Set up environment variables:

# Copy the sample environment file
cp .env-sample .env

4. Edit .env and add your Integration.app endpoints for API and IO:

NEXT_PUBLIC_INTEGRATION_APP_API_URL=http://localhost:9000/
NEXT_PUBLIC_INTEGRATION_APP_UI_URL=http://localhost:3001/

You can find these credentials in your Integration.app workspace settings.

Running the Application

1. Start the development server:

npm run dev
# or
yarn dev

2. Open http://localhost:3000 in your browser.

Project Structure

• /src/app - Next.js app router pages and API routes
  • /users - Example implementation of external data import
  • /api - Backend API routes for users and integration token management
• /src/components - Reusable React components
• /src/lib - Utility functions and helpers
• /src/models - Data models and types
• /public - Static assets

Template Features

Authentication

The template implements a simple authentication mechanism using a randomly generated UUID as the customer ID. This simulates a real-world scenario where your application would have proper user authentication. The customer ID is used to:

• Identify the user/customer in the integration platform
• Generate integration tokens for external app connections
• Associate imported data with specific customers

Users Example

The template includes a complete example of importing and managing users from an external application:

• User data model and TypeScript types
• API routes for user import and retrieval
• React components for displaying user data
• Integration with SWR for efficient data fetching
• Example of using the Integration.app client for data import

Available Scripts

• npm run dev - Start development server with hot reload
• npm run build - Build the application for production
• npm run start - Start the production server
• npm run lint - Run ESLint to check code quality

License

MIT