Consumer API

Getting started

The Consumer API is a versioned REST API for external integrations - dashboards, kiosks, chat bots, automation - to read locations, access points, and events, and issue remote unlocks, authenticated with an API key instead of a dashboard session.

Base path

Every endpoint lives under /api/consumer/v1on your Vestrane deployment's own domain. There is no separate API host to point at.

Full reference

This section is a narrative walkthrough with examples. For the complete, authoritative contract - every request/response schema and status code - see the API Reference.

Your first request

curl -H "Authorization: Bearer ves_live_example" \
  https://your-deployment.example.com/api/consumer/v1/locations

Replace ves_live_example with a real key from your dashboard's API Keys page (see Creating an API key), and the host with your actual deployment URL. Continue to Authentication.