Getting Started

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.

Discovery

We start with a kick-off call where both Commercial and Technical representatives on PureSpectrum and Client side cover the non-exhaustive list below.

The various use cases for testing the Buy API

Your development timeline for integrating our API

API or hybrid (both UI & API) preference

Phased development or trying all the features at once? If phased, which are the initial features required and which would be adopted later?

List of users who require access to the Staging environment

Preferred communication channel, Email or Slack?

Agreed cadence, to monitor progress.

Any other helpful information that might ease the process

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.

To tailor our support to your needs, we will also need the status update (including the survey IDs used for testing these features in Staging) on the following:

Using feasibility end point to check feasibility and price to launch the survey

Creating, updating and deleting quotas

Inbound and outbound hashing of survey URL and redirects

Creating survey groups and respondent exclusions for the survey

Production Access

Once the PureSpectrum SaaS agreement has been signed, you get access to our Production environment.

We can agree to arrange a meeting or recurrence, to review your API integration and address any question, concern or optimization option.

A Production access token is necessary to use all endpoints.

If you are currently a user of the UI, please inform us whether you prefer to utilize the same account for API calls or if you require a distinct account.

It is recommended to use a separate API account to maintain a clear distinction between API and UI surveys.

There are a few differences between our Staging and Production environments:

Different API keys

Different attributes

Different qualification codes

Dummy prices on staging

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 namely v2 and v3. Currently, v2 is mostly in use. Some end points are also using v3.

Test It Out

🕹 Test it out

To get going quickly, we recommend using an API collaboration tool (i.e. Postman, Apidog). Or you can use this documentation to try our collection of endpoints directly within your browser window.

📝 Changelog

Introducing a new endpoint? Updating an existing one? Deprecating or announcing a breakchange? All is found in the Changelog page.

The Changelog allows users to view new releases, updates, and critical changes to all APIs. This provides an excellent way for developers to stay up-to-date with the latest changes that are occurring on Buy API.

Getting Started with the API#

✅ Requirements#

API Versions#

Test It Out#

📝 Changelog#

Getting Started with the API

✅ Requirements

API Versions

Test It Out

📝 Changelog