API Reference
VIO v4 exposes multiple API surfaces for different integration scenarios. Use this page as the starting point when deciding which API set fits your product or backend workflow.
Available APIs
External API
Tenant-level REST API for backend integrations.
- Authentication:
X-API-Key - Best for: server-to-server workflows, tenant automation, analytics exports
- Main domains: vouchers, users, campaigns, tokens, analytics, staff PINs
Mini App API
JWT-based API for web apps embedded inside the VIO Member App.
- Authentication: refresh token -> access token
- Best for: iframe mini apps that need the current user's context
- Main domains: auth, user info, tokens, vouchers, admin actions
Public APIs
Public endpoints are documented inside the Mini App API guide. They help mini apps perform pre-login setup tasks such as PIN verification, tenant lookup, and store discovery.
Supporting Services
Web3 Asset Service
The VIO platform also relies on a dedicated Web3 asset service for wallet provisioning and on-chain token or NFT operations.
- Authentication:
X-API-Key - Capabilities: wallet creation, token mint/burn/transfer, NFT mint/transfer
- Reference: external Swagger UI provided by the platform environment