Software companies often provide access to Application Programming Interfaces (APIs) to allow their customers to extend the product and solve business problems. For example, in the world of optimization, an API can be used to automate certain aspects of the testing program or help test a feature or site release. In these ways and more, the SiteSpect Admin and Engine APIs can help you advance your optimization program. One of the most common uses of our APIs is to export test data into an analytics tool. But there is so much more you can do, and this blog will provide a brief overview.
SiteSpect API Overview
SiteSpect’s API is broken out into two main areas, the SiteSpect Admin API and the SiteSpect Engine API. The Admin API is used for the creation, launch, and monitoring of optimization campaigns. It can do anything that you would see in our Admin graphical interface. The Engine API can be used in place of the SiteSpect Cloud Engine to answer real-time questions like “what experience should I show this user?” and to capture events for monitoring and analytics. The Engine API is mostly used for native mobile applications and as an alternative to server-side testing with SiteSpect Origin Experiments.
SiteSpect Admin API
Our initial launch of the SiteSpect Admin API was driven by the need to programmatically extract data from our systems. Our customers could export report data manually, but using the API allows them to automate the process and ultimately save them time. Using the API, customers can easily use third-party products or internal dashboards to visualize our data. But this is just the start.
The Admin API builds on our existing RESTful API architecture and provides additional methods that help clients build and drive testing programmatically. There are many use cases that call for creating and modifying objects, integrating with existing systems, and automating manual tasks. They can also update different SiteSpect attributes such as Status or Assignment based on outside events like traffic spikes.
Why Test Programmatically?
When you test programmatically you can automate and accelerate the speed of your optimization programs. SiteSpect’s Admin API allows your IT release management software, like Jenkins, to create and launch tests as part of your release process. Imagine a script that creates a test for each site or new feature release. Our customers can easily do this using SiteSpect Origin Experiments® our API, and your release management software. Automation saves a lot of time and allows our customers to focus on other important tasks.
Additionally, our customers usually have multiple systems, such as a CMS or a data warehouse. The API provides a huge benefit in terms of integration. More automation and more efficient workflow can save a lot of time, money, and resources.
APIs can also affect the way that SiteSpect works. For example, we have a customer who plans to use an external model to manipulate the weighting of each Variation. This allows them to drive SiteSpect and their testing program to suit their specific needs.
Many customers extract report data programmatically and integrate that with analysis systems like Tableau to create custom dashboards and visualizations. Or, you can use the API to help with QA by sending traffic to our engines that load specific Variations in preview mode. And now you can create Campaigns programmatically and launch Campaigns automatically enabling a truly headless automated optimization solution.
SiteSpect Engine API
In the case of a native mobile or IOT application, SiteSpect offers an Engine API. This allows your application to offer personalization and testing capabilities without the need for using SiteSpect’s reverse proxy solution. The Engine API specializes in feature flag testing and personalization and fully integrates with the rest of SiteSpect’s optimization platform. Engine API campaigns can be used in combination with other campaigns and fully support omnichannel capabilities. This means that a user signed in to a mobile device or other application can be offered a consistent experience with what they see on your website or other digital experience.
How to Get Started
A good first step is to take a look at the API documentation which is located in the Help section of SiteSpect. Any SiteSpect customer can generate an API token with their user credentials and begin to use the expanded Admin APIs. If you have any questions about the API, contact our Help Desk. If you are just in the process of researching optimization solutions, you can see a demo of our API. Register here to request a demo.