Skip to content

Console

The console manages apps, API keys, and offline device activation codes under an Open Platform account.

App Management

An app is the ownership unit for API keys. When creating an app, provide:

FieldNotes
App nameDisplay name for a team or integration project.
RemarkOptional deployment, customer, system, or owner information.

After creation, the app has an appId and appKey. API keys are created under an app.

API Key Management

When creating an API key, confirm:

ItemNotes
Key nameInclude environment and purpose, such as prod-capture-svip.
License modeonline_api_key for online capabilities, offline_api_key for offline capabilities.
SDK tiervip, svip, or svip_plus.
ExpirationEmpty or non-positive expireDays means no explicit expiration; expiresAt can also be set.
Device scopedeviceScope controls devices accessible by the local runtime.

The full key is shown only once. If it is lost, rotate the key.

Rotation and Revocation

  • Rotation: copies the original key's mode, tier, device scope, and expiration, issues a new key, and marks the old key as REVOKED.
  • Revocation: immediately makes the key unusable. Clients should stop the current session and clear local configuration.

Offline Device Activation Codes

Offline activation is used for disconnected deployments or fixed-machine local authorization.

  1. The client or SDK runtime gets a machine code.
  2. Enter machineCode in the console.
  3. Generate authorizationCode.
  4. Activate the current local session with auth.activate_offline.

Limits:

  • Each Open Platform account can activate at most 2 different machines.
  • Re-submitting the same non-expired machine code returns the existing activation code.
  • Expired machine codes cannot be renewed.
  • Activation codes are valid for 30 days by default.

The 2-machine and 30-day validity policy is intended for Open Platform trial/test device activation. For more devices, market or commercial rollout, or adjusted activation quota and validity, contact CZUR business staff.

Relationship to SDK Runtime

The console issues and manages credentials; the SDK runtime uses them locally. Typical flow:

text
Create API key in console
  -> local runtime auth.create_session
  -> call capabilities according to auth_context.capabilities and device_scope
  -> online capabilities validate and consume quota through the gateway

CZUR Open Platform Documentation