VesuvioPay SDK Documentation
Welcome to the comprehensive documentation for the VesuvioPay SDK API. Build powerful e-commerce integrations with our flexible and developer-friendly API.
🚀 Quick Start
New to VesuvioPay? Start here:
- Getting Started - Get up and running in minutes
- Authentication - Learn how to authenticate your API requests
- Make Your First API Call - Try out the API
📚 What Can You Build?
VesuvioPay SDK provides everything you need to build modern e-commerce experiences:
🛍️ Product Management
Sync products from external platforms (Shopify, WooCommerce, custom systems) and manage your product catalog programmatically.
🛒 Cart Integration
Build shopping cart functionality with real-time inventory checks, product availability notifications, and abandoned cart recovery.
📦 Order Processing
Create orders from external platforms, update order statuses, and manage the complete order lifecycle.
🔔 Webhooks
Receive real-time notifications for cart events, order updates, and more to keep your systems in sync.
🏪 Shopify Integration
Set up the VesuvioPay Shopify app from scratch — create the app, install it on your store, and configure theme and checkout settings.
🎯 Core Concepts
Before diving into the API, familiarize yourself with these key concepts:
- Authentication - API keys, JWT tokens, and security best practices
- Rate Limiting - Understand rate limits and how to handle them
- Error Handling - Handle errors gracefully with proper error codes
- Webhooks - Real-time event notifications
📖 API Reference
Explore detailed documentation for each API endpoint:
- Customers API - Manage customer data
- Products API - Product and inventory management
- Cart API - Shopping cart operations
- Orders API - Order creation and management
- Store API - Store configuration and branding
- Webhooks API - Webhook endpoint management
🔑 Need API Keys?
- Log in to your VesuvioPay Dashboard
- Navigate to Settings > API Keys
- Generate a new API key pair (test or production)
Always use test keys (pk_test_... and sk_test_...) during development. Switch to production keys only when you're ready to go live.
💬 Need Help?
- 📧 Email Support: support@vesuviopay.com
- 💬 Community Discord: Join our Discord
- 📝 GitHub Issues: Report bugs or request features
Ready to get started? Head over to the Getting Started Guide to make your first API call!