Offline Request Schema

Overview

As part of our ongoing efforts to strengthen security, we have introduced Schema Version 2 (v2) for offline requests. This update enhances request integrity by ensuring the entire payload is signed and verifiable.

Schema Version 2 (v2) – Changes

Schema v2 introduces full payload signing and request versioning.

Key Changes

  • Schema Version Field

    • Every request now includes a schema_version field.

    • Allows License API to detect and handle the request format.

  • HMAC-SHA256 Signature

    • The entire request JSON is signed using HMAC-SHA256 with the client secret or shared key.

    • Ensures all fields are protected from tampering.

  • Nested Request Object

    • The signed request is wrapped in an outer JSON object.

    • The request field must remain a proper JSON object (not a string) to allow correct parsing and signature verification on the License API side.

Example (v2)

Benefits of v2

  • Full payload integrity: all fields are signed, including previously optional fields.

  • Backward-compatible: older SDKs using v1 requests will still work while v2 enables enhanced security.

  • Simplifies License API parsing and signature verification.

Enabling Schema Version 2

1

Step

Log in to the Vendor Platform.

2

Step

In the left sidebar, go to SettingsPreferences.

3

Step

Locate the Minimum Offline Request Schema Version section.

4

Step

Select V2 from the dropdown list.

By default, this setting is Version 1, so you must switch it to Version 2 to start generating v2 offline requests.

Schema Version Selection

Offline schema v2 requires an SDK version that supports v2. Check your SDK documentation (and changelogs) under SDKs before enabling.

Last updated

Was this helpful?