Skip to main content

Quick Start Guide

Get up and running with VKM in under 10 minutes.

Prerequisites​

Before you begin, ensure you have:

  • ✅ A Salesforce account (Production, Sandbox, or Developer)
  • ✅ A PostgreSQL database (version 12+)
  • ✅ Valid email address

Step 1: Sign Up​

Create your VKM account with automatic workspace provisioning.

Visit your API endpoint and sign up with your email and password.

Step 2: Verify Email​

Check your email inbox for the verification link and click it.

Step 3: Sign In​

Authenticate to get your access token.

Store the access token securely - you'll need it for all subsequent API calls.

Step 4: Create a Project​

Projects group your sync configurations together.

Use the /api/projects/ endpoint to create your first project.

Step 5: Configure Salesforce Connection​

Connect your Salesforce org using OAuth flow.

Step 6: Configure PostgreSQL Connection​

Add your PostgreSQL database connection details.

Step 7: Select Salesforce Objects​

Choose which Salesforce objects to sync (Account, Contact, Opportunity, etc).

Step 8: Run Your First Sync​

Trigger a manual sync and watch your data flow!

Success!​

Your data is now syncing from Salesforce to PostgreSQL! 🎉

Next Steps​

  • Schedule automatic syncs
  • Monitor your projects
  • Configure advanced field mapping

Need Help?​

Contact support at support@vkmtechnosolutions.com