Skip to content

General Considerations

As part of the latest version of the SDK, several structural and functional changes have been introduced to improve modularity, clarity, and maintainability of integrations. Below are the key migration considerations for developers and integration teams.

Reorganized JSON Configuration Structure

The configuration structure has been modularized into three distinct sections, each managed either through a separate file or as a root-level key within the JSON structure.

  • Medias (medias)
    • All references to images and media resources (e.g. logos or images) could now be placed in a separate file, or under the root-level medias key in the JSON.
    • This can include URLs or identifiers pointing to pre-uploaded assets.
  • Setup (setup)
    • Contains all SDK configuration (e.g detection timeout or path to assets) could now be placed in a separate file, or under the root-level setup key in json
    • This includes all configurable parts of the SDK.
  • Styles (styles)
    • All UI customization parameters (e.g., color palette, typography, component styles) could now be declared in a separate file, or under the root-level styles key in the JSON.
    • This ensures a clean separation between content and presentation.
  • Texts (texts)
    • All text-related content could now be placed in a separate file, or under the root-level texts key in the JSON.
    • This includes texts like interface messages, titles or instructions

Migration Summary and Best Practices

To ensure a successful migration, organize your JSON configurations following the new modular model. This updated structure offers greater flexibility and scalability, making it especially effective for clients who need dynamic, localized, or branded experiences.