Installation Guide

Integration Setup Guide

Last updated: Jan 03, 2026

Integration Setup Guide

Complete guide for setting up all integrations with the Sunsky plugin.

Required Integrations

1. Sunsky API Integration

Connect to Sunsky's wholesale platform.

Steps:

  • Create account at Sunsky Online
  • Apply for API access in your account dashboard
  • Wait for approval (1-3 business days)
  • Copy API Key and Secret from dashboard
  • Configure in Admin → Sunsky → Settings
  • Click Test Connection to verify

    • Environment Variables: 

    SUNSKY_API_KEY=your_api_key

    
SUNSKY_API_SECRET=your_api_secret
SUNSKY_BASE_URL=https://open.sunsky-online.com

    2. License Server Integration

    Activate your plugin license.

    Steps:

  • Get purchase code from CodeCanyon
  • Go to Admin → Sunsky → License
  • Enter purchase code
  • Click Activate License

    • Environment Variables: 

    SUNSKY_LICENSE_SERVER=https://license.example.com

    
SUNSKY_LICENSE_CLIENT_KEY=lsk_your_key
SUNSKY_LICENSE_CLIENT_SECRET=lss_your_secret

    Optional Integrations

    3. OpenAI Integration (Extended License)

    Enable AI-powered features.

    Requirements:

    • Extended License activated
    • OpenAI account with API access
    • Active billing on OpenAI account

    Steps:

  • Create OpenAI account at platform.openai.com
  • Generate API key
  • Add billing method
  • Configure in Vendor → Sunsky → OpenAI Settings
  • Click Test Connection
    • Each vendor uses their own OpenAI API key. All API costs are billed directly by OpenAI to the vendor.

    4. Queue Configuration

    For background processing of imports and syncs.

    Recommended setup: 

    QUEUE_CONNECTION=redis

    Start worker: 

    php artisan queue:work --queue=sunsky,default

    5. Cache Configuration

    For improved performance.

    Recommended setup: 

    CACHE_DRIVER=redis

    
SUNSKY_API_CACHE_TTL=300
SUNSKY_ENABLE_QUERY_CACHING=true

    Integration Checklist

    • [ ] Sunsky API credentials configured
    • [ ] License activated
    • [ ] Database migrated
    • [ ] Assets published
    • [ ] Cache configured
    • [ ] Queue worker running (optional)
    • [ ] Email/SMTP configured (optional)
    • [ ] OpenAI configured (Extended License only)

    Verification Commands

    php artisan sunsky:status

    
php artisan sunsky:test-connection
php artisan sunsky:verify-license