To assess whether PureSpectrum Buy API answers your online sample needs, start with a review of our Buy API Documentation.Do not hesitate to get in touch with your PureSpectrum representative for any questions that you might have.š Getting Started#
Why integrate with our Buy API?Use your own system/UI to program your survey
Automation of repetitive tasks and workflows
Improved efficiencies, by removing manual tasks, reducing errors and increasing productivity
Scalability, to keep up with your growing business
API access requires the authorization parameter in the request header.
You will receive different keys for Production and Staging.
āļø The Process
#
1
Discovery
We start with a kick-off call where both Commercial and Technical representatives on the PureSpectrum and Client side cover the non-exhaustive list below:
1.
The various use cases for testing the Buy API
2.
Your development timeline for integrating our API
3.
API or hybrid (both UI & API) preference
4.
A demo of the system you'll be integrating with the API
5.
Phased development or trying all the features at once? If phased, which are the initial features required and which would be adopted later?
6.
List of users who require access to the Staging environment
7.
Preferred communication channel, Email or Slack?
8.
Agreed cadence, to monitor progress
9.
Any other helpful information that might ease the process
2
Staging Access
You are granted access to our Staging environment, for testing all available features. Staging login accounts are created for the confirmed users.
A staging access token is necessary to test all endpoints.
Usage of the feasibility endpoint to check feasibility and recommended price, without creating a survey
Correct survey setup based on various qualifications, quotas, and price
Inbound and outbound hashing of redirects
3
Go-Live Testing
Verifying that hashing and redirects are set up correctly and working
Testing of survey lifecycle management (survey creation, updating, transitioning through statuses)
Respondent status is coming back to PureSpectrum with the correct status
Audiences & Quotas are being defined correctly, and in line with your expectations
The consumption of feasibility and subsequent defining of CPI
Updating transactions and reconciliation
4
Production Access
Once the PureSpectrum SaaS agreement has been signed and we have successfully checked your test survey setups, redirects, and hashing, you get access to our Production environment.
A Production access token is necessary to use all endpoints.
If you are currently a user of the UI, please let us know whether you prefer to use the same account for API calls or require a distinct account.It is recommended to use a separate API account to maintain a clear distinction between API and UI surveys.
5
Monitor and Review Real Surveys in Production
Production API Key & login credentials provided
Soft launch and monitor small-sample sizes across a few surveys
Review survey results and full launch
6
Optimize: Performance Recommendations and New Features
PureSpectrum makes recommendations for API optimization
Integration enhancements by the customer
New features / API endpoints communicated on an ongoing basis
Different qualification codes
Dummy feasibility on staging
Dummy suppliers on staging
No real traffic on staging
Getting Started with the API#
PureSpectrum Buy APIs are a suite of REST endpoints, purpose-built for secure, fast, and easy access.Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.ā
Requirements#
For a straightforward interaction with our Buy API, consider the following as minimum requirements:A PureSpectrum Buy API account
API key or authentication credentials with appropriate permissions
Basic understanding of programming, API consumption, and JSON schema
Familiarity with HTTP methods (GET, POST, PUT, DELETE) and status codes
Ability to handle API error codes
Secure storage of API credentials to prevent unauthorized access
Compliance with any applicable data privacy and security policies
Understanding of response formats and how to parse relevant data for business needs
API Versions#
There are two API versions, v2 and v3. Currently, v2 is mostly in use; some endpoints also use v3.Test It Out#
To get going quickly, we recommend using an API collaboration tool (e.g. Postman, Apidog). You can also use this documentation to try our collection of endpoints directly within your browser, using the Try it button and your Staging token on each endpoint page. All testing done via the Try it button will be reflected in your PureSpectrum Staging account.
| Survey Type | Build | Go Live | Optimization |
|---|
| Simple surveys (basic qualifications and quotas) | 2 - 4 weeks | 4 - 10 weeks | 1 - 2 weeks |
| Complex surveys (advanced targeting, complex quotas) | 4 - 8 weeks | 8 - 16 weeks | 2 - 4 weeks |
| Enterprise-level integrations | 6 - 18 weeks | 10 - 20 weeks | 2 - 6 weeks |
š Changelog#
Introducing a new endpoint? Updating an existing one? Deprecating or announcing a breaking change? It's all in the Changelog page.The Changelog lets users view new releases, updates, and critical changes to all APIs ā an easy way for developers to stay up to date with the latest changes to the Buy API. 