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 (for example, logos or images) can now be placed in a separate file, or under the root-level
mediaskey in the JSON. - This can include URLs or identifiers referencing assets already bundled with the app.
- All references to images and media resources (for example, logos or images) can now be placed in a separate file, or under the root-level
- Setup (setup)
- All SDK configuration (for example, detection timeout) can now be placed in a separate file, or under the root-level
setupkey in JSON. - This includes all configurable parts of the SDK.
- All SDK configuration (for example, detection timeout) can now be placed in a separate file, or under the root-level
- Styles (styles)
- All UI customization parameters (for example, color palette, typography, component styles) can now be declared in a separate file, or under the root-level
styleskey in the JSON. - This ensures a clean separation between content and presentation.
- All UI customization parameters (for example, color palette, typography, component styles) can now be declared in a separate file, or under the root-level
- Texts (texts)
- All text-related content can now be placed in a separate file, or under the root-level
textskey in the JSON. - This includes interface messages, titles, and instructions.
- All text-related content can now be placed in a separate file, or under the root-level
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.