Vepler API Documentation

Overview

The Vepler API uses API key authentication for all requests. You must include your API key in the x-api-key header of every request.

Keep your API keys secure! Never expose them in client-side code or public repositories.

Obtaining API Keys

Create Account

Navigate to API Keys

Go to Settings → API Keys in your dashboard

Generate New Key

Click “Create New Key” and give it a descriptive name

Copy & Secure

Copy your key immediately - it won’t be shown again

Making Authenticated Requests

Include your API key in the x-api-key header:

import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY
});

// Make a request
const response = await vepler.property.getV1PropertyLocationIds({
  locationIds: 'p_0x000123456789'
});

const response = await fetch('https://api.vepler.com/v1/property/p_0x000123456789', {
  headers: {
    'x-api-key': 'vpr_live_abc123...',
    'Content-Type': 'application/json'
  }
});

const result = await response.json();

curl -X GET "https://api.vepler.com/v1/property/p_0x000123456789" \
  -H "x-api-key: vpr_live_abc123..." \
  -H "Content-Type: application/json"

import requests

headers = {
    'x-api-key': 'vpr_live_abc123...',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.vepler.com/v1/property/p_0x000123456789', headers=headers)
data = response.json()

API Key Format

API keys use the prefix vpr_live_ followed by a unique identifier:

vpr_live_sk_1234567890abcdef

Security Best Practices

Environment Variables

Never hardcode API keys. Use environment variables:

// Don't do this
const apiKey = 'vpr_live_sk_1234567890';

// Do this instead
const apiKey = process.env.VEPLER_API_KEY;

.env

VEPLER_API_KEY=vpr_live_sk_1234567890

Key Rotation

Rotate your API keys regularly:

Generate a new key in the dashboard
Update your application with the new key
Verify the new key works
Delete the old key from the dashboard

Server-Side Only

Always make API calls from your server, never from client-side code. Your API key should never be exposed in browser JavaScript, mobile apps, or public repositories.

Error Handling

Handle authentication errors gracefully:

try {
  const response = await vepler.property.getV1PropertyLocationIds({
    locationIds: 'p_0x000123456789'
  });

  if (response.errorResponse) {
    console.error('API Error:', response.errorResponse.error);
  }
} catch (error) {
  if (error.statusCode === 401) {
    console.error('Invalid or missing API key');
  } else if (error.statusCode === 403) {
    console.error('Insufficient permissions');
  }
}

Authentication Errors

Status Code	Description	Solution
`401`	Invalid or missing API key	Check your API key is correct and included in the `x-api-key` header
`403`	Insufficient permissions	Your API key does not have access to this resource

Testing Authentication

Verify your setup with a health check endpoint:

import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY
});

const health = await vepler.system.getV1PropertyHealth();
console.log(health);

curl -X GET "https://api.vepler.com/v1/property/health" \
  -H "x-api-key: YOUR_API_KEY"

Next Steps

Quick Start

Build your first integration

API Reference

Explore all endpoints

TypeScript SDK

Use the official SDK

Error Handling

Handle errors effectively

Getting Started

Concepts

Authentication

Overview

Obtaining API Keys

Making Authenticated Requests

API Key Format

Security Best Practices

Error Handling

Authentication Errors

Testing Authentication

Next Steps

Quick Start

API Reference

TypeScript SDK

Error Handling

​Overview

​Obtaining API Keys

​Making Authenticated Requests

​API Key Format

​Security Best Practices

​Error Handling

​Authentication Errors

​Testing Authentication

​Next Steps

Quick Start

API Reference

TypeScript SDK

Error Handling

Overview

Obtaining API Keys

Making Authenticated Requests

API Key Format

Security Best Practices

Error Handling

Authentication Errors

Testing Authentication

Next Steps