Web SDK API¶
The Web SDK provides a comprehensive interface for working with the browser to track, personalize, and automate what you need on the web. Whether you want to track an event, monitor viewable content, or personalize visitor experiences, the Web SDK provides a robust foundation for all of these capabilities.
There are two main ways to work with the Web SDK:
- Use the command queue to perform basic actions with the Web SDK.
- Write a plugin to take full advantage of the Web SDK and its capabilities.
Brief Overview¶
Below is a brief overview of the major parts of the Web SDK. Each part can be explored deeper through the sections of this documentation.
Bootloader¶
The snippet installs a tag manager, which we call the Bootloader. The bootloader provides basic browser functionality and core polyfills required to provide an efficient and modern interface for the rest of the SDK. All functionality of the bootloader is available through the command queue.
Scopes¶
Scopes are localized versions of a Bootloader. Where the Bootloader exists as a global tag manager that manages the entire SDK, Scopes exist at a level underneath where all Bootloader functionality is isolated to the Scope itself and its members.
Namespaces¶
Namespaces are the root organizational construct for the Web SDK. They provide an isolated set of plugins, services, and API modules for you to use. When a website needs to host a Web SDK environment for multiple accounts, this can be done with Namespaces.
Modules¶
Modules are core browser functionality built into the Web SDK. The modules wrap core features in the browser to make tracking and tagging easier for any developers working on dealership websites, widgets, and plugins.
Plugins¶
Plugins are the suggested way of using the Web SDK. They plug into a namespace and provide access to all of the services and modules the SDK provides. Most of the non-core features of the SDK provided by Orbee are done through plugins.
Services¶
Services are special plugins that provide an additional benefit -- they connect Orbee's back end to the Web SDK. Through services, you can access inventory, shopper viewed vehicles, interests, trade-in information, and more.