🚀 Good Integration Guide#
Integration depth with the PureSpectrum Buy API varies by buyer - this guide covers the core functionality we recommend most integrations include to get the most value from the platform.Attributes#
Fetch targeting questions by locale, with qualification codes, condition codes, and answer ranges where applicable. These codes are required later for survey targeting and quotas.Call this endpoint periodically to stay in sync as questions and answers are added.Feasibility#
Get maximum feasibility and suggested pricing based on field time, completes, LOI, IR, and targeting criteria - before launching. Adjust and retry to further tweak.Use this to inform pricing. If end users create their own surveys in your tool, add your markup on top of the returned price.Create Surveys#
Create surveys with your targeting criteria, using the qualification and condition codes returned by the Attributes endpoint.Update Surveys#
Use the update endpoints to adjust surveys pre-launch or in-field, so you can react quickly to fielding or performance issues.Prefer PATCH over PUT where available - PATCH updates only the fields you send, while PUT requires a full overwrite. Survey status and offer price each have their own dedicated endpoint.Add Quotas#
Quotas are usually set at launch. Use the add endpoint to set up quotas on a survey, or to add new ones mid-field as required.Update Quotas#
Adjust or remove quotas mid-field as needed. PATCH updates a quota's current target only - use PUT for any other changes.Redirects & Hashing#
PureSpectrum provides a robust yet easy-to-understand redirect and hashing mechanism to prevent abuse and fraud.All clients using the Buy API must implement redirects and hashing to protect our mutual systems.
Implementing Status & Reference Codes#
PureSpectrum APIs use various status and reference codes - survey status, respondent status, localization, age units, and currency. Review these regularly and keep your mappings current.Registering Completes#
We recommend using the "Register transaction as complete" endpoint as an extra verification layer alongside our hashing mechanism when redirecting respondents back to PureSpectrum.Reconciliation#
PureSpectrum's reconciliation APIs let you update transaction status after client-side quality checks, so you can reject respondents that don't meet quality standards.Production Access#
Implementing the functionality within this document as described, makes gaining access to production quicker and easier.Diagram of flow for reference#
