Connecting REST API

Overview

Prerequisites

• API base URL (e.g., https://api.example.com)
• API credentials (Bearer token, API key, or username/password)
• API documentation (to understand available endpoints)

Step-by-Step Instructions

1. Navigate to Data Sources

1. Go to Data Sources from the main navigation
2. Click Connect New Data Source
3. Select REST API from the available options

2. Enter Connection Details

• Connection Name: Give your API a descriptive name (e.g., "Shopify API", "Qashier POS API")
• Base URL: Enter the base URL of your REST API
• - Example: https://api.shopify.com
• - Example: https://api.qashier.com

3. Configure Authentication

• Authentication Type: Select "Bearer Token"
• Bearer Token: Enter your API bearer token
• Commonly used for OAuth2 and modern APIs

• Authentication Type: Select "API Key"
• API Key: Enter your API key
• API Key Header Name: Specify the header name (default: "X-API-Key")
• - Common values: X-API-Key, Authorization, apikey

• Authentication Type: Select "Basic Auth"
• Username: Enter your API username
• Password: Enter your API password

• Authentication Type: Select "OAuth2 (Bearer Token)"
• OAuth2 Access Token: Enter your OAuth2 access token
• Note: Full OAuth2 flow setup coming soon

4. Configure Endpoints (Optional)

• Key: A friendly name (e.g., "orders", "products")
• Value: The API path (e.g., "/api/v1/orders", "/api/v1/products")

• orders → /api/v1/orders
• products → /api/v1/products
• customers → /api/v1/customers

5. Test Connection

1. Click Test Connection to verify your API is accessible
2. The test will make a GET request to your base URL
3. If successful, you'll see a green success message

6. Select Access Mode

• Online (Live Connection): Real-time API queries
• Offline (Cached Data): Use cached API responses
• Hybrid: Combination of both

7. Connect REST API

1. Click Connect REST API
2. Wait for the connection to be established
3. You'll be redirected to see your connected data source

Common Use Cases

POS Systems

• Qashier, StoreHub, MEGAPOS
• Retrieve sales data, inventory levels, customer information

CRMs

• HubSpot, Zoho CRM, Salesforce
• Access customer data, deals, contacts

Delivery Platforms

• Deliveroo, Foodpanda, GrabFood
• Monitor orders, track delivery status

Accounting Systems

• QuickBooks, Xero, MYOB
• Access financial data, invoices, transactions

Authentication Examples

Bearer Token

API Key in Header

Basic Auth

Troubleshooting

Connection Failed

• Verify your base URL is correct and accessible
• Check if the API requires HTTPS
• Ensure your IP is whitelisted (if required)

Authentication Errors

• Verify your token/key is valid and not expired
• Check the correct header name for API keys
• For OAuth2, ensure your access token hasn't expired

401 Unauthorized

• Double-check your credentials
• Verify the authentication method matches the API requirements
• Check if the token needs to be refreshed

403 Forbidden

• Verify your API key has the necessary permissions
• Check if your account has access to the requested resources

404 Not Found

• Verify the base URL is correct
• Check if the API endpoint path is correct
• Review the API documentation for the correct endpoint structure

Next Steps

• Go to Agent Builder to create an AI agent using this REST API
• Configure your agent to query specific endpoints
• Set up automated workflows using API data