Skip to content
Pluggi Docs

API Integrations

API Integrations allow you to connect your Pluggi agent to external systems and access real-time data.

Overview

Section titled “Overview”

API Integrations are configured in Settings > Integrations > API Integrations. Once set up, your agent can interact with external services to provide better responses and functionality.

Supported POS Systems

Section titled “Supported POS Systems”

Pluggi integrates with major Point-of-Sale platforms:

  • Dutchie
  • Jane
  • Buddy

Setting Up an API Integration

Section titled “Setting Up an API Integration”

Step 1: Select Your Provider

Section titled “Step 1: Select Your Provider”
  1. Navigate to Settings > Integrations > API Integration
  2. Choose your POS partner from the available list

Step 2: Provide Credentials

Section titled “Step 2: Provide Credentials”
  1. Obtain your API credentials from your POS provider
  2. Enter your API keys, tokens, or other credentials in the integration form
  3. Ensure you have the correct permissions enabled in your POS account

Step 3: Test the Connection

Section titled “Step 3: Test the Connection”
  1. Click the “Test Connection” button
  2. Pluggi will verify connectivity with your service
  3. Confirm that the test was successful before proceeding
  4. Review the fetched data preview to see what information is available

Step 4: Finalize and Sync

Section titled “Step 4: Finalize and Sync”
  1. Click “Save” to finalize the integration
  2. Pluggi will begin syncing data from your system
  3. Data will stay synchronized in real-time

Using API Calls in Your Flow

Section titled “Using API Calls in Your Flow”

Once you’ve set up an API integration in Settings, you can use API Call blocks in your Flow Builder.

API Call Block Setup

Section titled “API Call Block Setup”
  1. In your Flow Builder, drag an API Call block from the block list onto the canvas
  2. The block will automatically show a mapping data UI if you’ve already set up the integration in Settings
  3. View the sample data shown in the mapping UI
  4. Map the fetched data to the attributes you’ve created in your agent

Key Mapping

Section titled “Key Mapping”

When mapping data:

  • Identify which API fields contain the data you need
  • Select the corresponding agent attributes to populate
  • For example: API field product_name → Agent attribute product

Error Handling

Section titled “Error Handling”
  • Set a fallback message if the API call fails
  • Test all API endpoints before deploying
  • Have contingency flows if APIs are unavailable

Troubleshooting

Section titled “Troubleshooting”

Connection Test Failed

Section titled “Connection Test Failed”
  • Verify API credentials are correct
  • Check that the POS provider is functioning properly
  • Ensure your Pluggi account has permission to access the API
  • Contact the POS provider for authentication issues

Data Not Syncing

Section titled “Data Not Syncing”
  • Verify the test connection passed
  • Check API rate limits haven’t been exceeded
  • Wait a few minutes for the initial sync to complete

API Calls Returning Errors

Section titled “API Calls Returning Errors”
  • Verify the API endpoint is accessible
  • Check that your key mapping is correct
  • Ensure all required attributes are set up in your agent
  • Review the preview data to ensure fields exist

Support

Section titled “Support”

For issues with API integrations:

  • Contact Pluggi support at pluggi@support.com
  • Provide your API provider name and specific error messages
  • Include test results and configuration details

Next Steps

Section titled “Next Steps”