First let's understand what are "Insights Exchange" APIs ?
An API, or Application Programming Interface, are mechanisms that enables two software components to communicate with each other using a defined mechanisim. It give's secured access to the required (limited) data, without sharing the backend database. APIs are a key part of the internet, enabling cloud services, mobile apps, and web-based services.
The api's defines how the two software can communicate with each other, using requests and responses. Majority api provider's provide documentations, which contains information on how developers have to use (structure) those requests and responses and use their api's to read and/or write data.
Survey Back Office "Insights Exchange APIs" are used to share the insights of your active survey projects with your panel-vendors. It also facilitates to share "redirection insights".
Things a developer should know
All references to Survey Back Office URLs in this documentation refer to our live environment. The live domain is https://api.surveybackoffice.com
The SBO (Survey Back Office) Insights Exchange API aims to provide a RESTful interface for providing online sample via the SBO platform in a fully automated way. The API has been designed and developed to allow a high level of flexibility and security.
The SBO Insights Exchange API is a RESTful web API that strives to conform to the design principles of Representational State Transfer (REST). To fully harness these capabilities, you, as a developer, should have a good understanding of REST as an architectural style, and its key principles and constraints. If you are unfamiliar with REST, Wikipedia’s description is a good place to start.
Prerequisites
The SBO Insights Exchange API defines the following prerequisites. These prerequisites will be described in more detail in the relevant sections:
- An API Username as provided by Survey Back Office and an API Password setup by the company. The API key is unique to each client company. The client must keep this key secure at all times.
- Any programming language that fully supports communication via the HTTP protocol.
Security Concerns For Insights Sharing
These SBO's Insights Exchange api's are highly secured and will provide the insights only to it's relative company (your client/vendor) and that too if you share your api credentials.
To keep the insights more safe and also to take care of human errors, we have provided dual credentials security, which means to activate the api you will require a common "api username & api password" and to exchange insights with your company (your client/vendor) you will again require company wise credentials. If your companies have both the credentials then only they will be able to view their relative insights.
Getting Started with APIs
The SBO Insights Exchange API aims to allow our clients to build technical integrations, where their systems communicate directly with the SBO platform, in order to provide surveys from their available and active survey inventory and that too in a fully automated way.
The SBO Insights Exchange API aims to provide insights of surveys and redirection insights and all the api's have a different end-points. To move ahead with relative apis click on it