SDK Extensions Guide
Expand the design capabilities of Ceros by using our SDK Extensions to push your project to the next level
What is the Ceros SDK?
The Ceros Software Development Kit [SDK] is a set of tools that help you unlock creative solutions to problems. By leveraging our prewritten SDK Extensions and this guide, you can use extend the native functionality of the Ceros platform.
What can you use the SDK for?
- Building a quiz
- Gamifying your experience with scorekeeping, object collection and more
- Building a calculator
- Granular analytics tracking
- Generating a social share link
- Controlling and manipulating audio
- …and more!
Who is it for?
If you want to integrate one of the existing extensions built by Ceros with our SDK, coding experience isn’t necessary. A general understanding of the Ceros Studio is all you need to dive in. And if you have any troubleshooting issues after going through our step-by-step implementation instructions, you can chat our Support Team. They’re always happy to help.
The SDK Panel is the place to locate identifying information about your Experience as well as assign Tags and Payloads to help you programmatically handle your content.
With the Ceros SDK, there are two basic ways to identify something: Tags and IDs. SDK Tags are values you can enter in the SDK Panel in order to identify an object of page. With our pre-built quiz extensions, for example, we identify each question page with the Tag question and each result page with results so that they can be managed easily within the code. After typing in a Tag, hit enter to apply it to the target object or page.
NOTE: You can add multiple tags to a singl target object.
Component, Page, and Experience IDs
In Ceros, each Experience, Page, and Component have unique identifies. these IDs can be used to locate a specific instance of your target in order to read its attributes or manipulate it.
Every Page and Component has an information entry area called a Payload. In contrast to Tags, wich are commonly applied to multiple targets and used for classification, Payloads generally contain unique information. For instance, our SDK Audio plugin uses the payload field to hold the URL of an MP3 file that the Studio reads in order to play sound in an Experience.
NOTE: A Component or page can only have one payload.
Connecting your Experience to the SDK Extension
To get the extension to work with your Experience, you’ll need to copy a line of code and paste it in the Custom HTML tab in the Studio’s Settings panel. Follow the instructions in the Extensions user guide to get everything configured and ready to go.