API Documentation

RESTful API for vendor integrations, product management, and order processing

Version 1.0.0
REST API
OpenAPI 3.0
Getting Started
Generate API keys and make your first request
View authentication guide →
Interactive Docs
Try API calls directly from your browser
Open Swagger UI →
API Reference
Complete endpoint reference with examples
View all endpoints →
Authentication
All API requests require authentication using API keys

Generating API Keys

Generate API keys from your vendor dashboard at /vendor/settings/api

Key Format

vk_{env}_{random_string}

Usage

Include your API key in the Authorization header:

Authorization: Bearer {your_api_key}

Environments

Test (vk_test_)

Use test keys for development and testing. Prefixed with vk_test_

Production (vk_live_)

Use production keys for live transactions. Prefixed with vk_live_

Best Practices

  • ✓Never commit API keys to version control
  • ✓Rotate keys regularly (every 90 days recommended)
  • ✓Use different keys for different environments
  • ✓Store keys securely using environment variables
  • ✓Revoke keys immediately if compromised
  • ✓Never share your production API keys

Questions? Contact our API support team at api@furnituredepartment.com