Quick Start Guide

Get up and running with the AIVA Platform in 5 minutes.

Step 1: Get Your API Credentials

Option A: If you're a merchant:

1. Log in to your AIVA merchant dashboard at https://dash.getaiva.ai
2. Navigate to Settings → API Access
3. Click "Generate New API Key"
4. Copy your API Key and Merchant ID (GUID format)

Option B: If you're an agency/developer:

1. Request sandbox access at developers@aiva.nz
2. Receive test merchant credentials
3. Use test API keys for development

Step 2: Test Your Connection

# Replace with your actual credentials

export AIVA_API_KEY="your-api-key-here"
export AIVA_MERCHANT_ID="your-merchant-id-here"

# Test the API

curl -X GET "https://api.getaiva.ai/api/merchant/${AIVA_MERCHANT_ID}/info" \
  -H "X-API-Key: ${AIVA_API_KEY}"

Expected Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "storeName": "My Pet Store",
  "subscriptionTier": "Professional",
  "email": "owner@mypetstore.com",
  "currency": "USD"
}
`"

### Step 3: Choose Your Path

Pick the integration approach that fits your needs:

| Path | Best For | Time to Build |
| --- | --- | --- |
| **AI Assistant Integration** | Merchants wanting conversational data access | 10 minutes |
| **Automation Workflows** | Marketing automation, scheduled tasks | 30 minutes |
| **Custom Dashboard** | Agency partners, white-label solutions | 4-8 hours |
| **Mobile App** | On-the-go merchant management | 1-2 days | -