Introduction

Welcome to the VAKA Online API 🙂

The VAKA Online API allows you as an integrator to manage different aspects of a VAKA system, giving you all the possibilities to extend your solution with VAKA access control features and beyond.

General API Concepts

Event-Driven

The VAKA Online API is event-driven by design to provide a modern and scalable experience with high performance in mind, supporting the following patterns:

  • Fetching required data (for example doors) from the API, allowing you to intially collect the current state and establish a baseline.

  • Subscription on changes, where events is published to registered webhooks to signal state changes. This differs from a traditional and usually exhaustive "polling" approach - instead things are pushed to you when necessary.

Asynchronous Request-Response Pattern

  • Requested operations through the API is typically accepted (returning 202 Accepted) and queued for execution as soon as possible, leaving you offloaded to continue with other things.

  • Once the requested operation is completed, the result is delivered to you as webhook event.

Last updated