DEVELOPER QUICK START

KioWare Developer Quick Start

A 15-minute reference guide to create a session, discover capabilities, send idempotent commands and receive KioWare events.

KioWare Developer Quick Start
15-MINUTE QUICK START

Reference-guide objective

Create a test session, inspect device capabilities and send an idempotent command. Endpoints and payloads are previews for architecture discussions, not production credentials.

1. Request accessObtain sandbox and app identity.
2. Create a sessionBind Kiosk, app, locale and policy.
3. Discover capabilitiesRead reader, printer and camera state.
4. Send a commandUse timeout and an idempotency key.
5. Receive eventsCorrelate trace and correlation IDs.
6. RevokeEnd the session and verify audit evidence.
REQUEST EXAMPLE

Create a test session

bash
curl -X POST https://sandbox.example.internal/v1/sessions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-001" \
  -d '{"kioskId":"KSK-DEMO-01","applicationId":"app-demo","locale":"vi-VN"}' 
Do not use the example URL in production. Hosts, authentication, scopes and schemas are issued per project.
DOWNLOADS

Reference assets

OpenAPI PreviewYAML · OpenAPI 3.1Download
Postman CollectionJSON · Example variablesDownload
SECURITY CHECK

Before moving from sandbox to UAT

  • mTLS / token lifecycle / secret storage
  • Scope và least privilege
  • Timeout, retry và idempotency
  • Masking, logging và evidence
  • Versioning, rollback và incident contact
EXECUTIVE BRIEFING · TECHNICAL WORKSHOP

Turn a Kiosk requirement into an auditable delivery scope

Assess TCO, APIs, HAL, IAM, peripherals, PoC, UAT and the production roadmap with the KioWare team.