Connecting to the API

The PureSpectrum API is a REST based API.  The URL structure is as follows:

URL Structure

{Base URI}/{Module}/{API Version}/{Resource}

eg: 

http://staging.spectrumsurveys.com/suppliers/v2/surveys

Base URLs

• http://staging.spectrumsurveys.com   (Test)

• https://api.spectrumsurveys.com    (Production)

Modules

• Supplier

Resources

surveys {get}
surveys/:survey_id {get}
surveys/register {post}
surveys/qualifications-quotas {get}
surveys/:survey_id/PSIDRef {get}
surveys/:survey_id/PSIDEligible {get}

Response Content Type

• application/JSON

To access the API, you will need to include an authorization parameter in the request header.

Each request needs to include your API access token.  

Example:  

headers: { 'access-token': '$accessToken' }

Access tokens are issued by your PureSpectrum representative. 

Postman example:

The Supplier API uses standard HTTP status codes to indicate success or failure of an API Request.  In general, API status would indicate success or failure status.

Status Code Summary