Getting Started

Implementation Notes

This API must be used server 2 server and not from the client-side (given that the API calls contain secret credentials).

The user agent and IP address in the ‘/get-surveys-for-user’ call should be that of the user, as these parameters are used for targeting purposes.

Credentials:

To begin testing your integration, please reach out to [email protected] to request staging credentials. These credentials will allow you to access the Prodege staging environment for testing purposes only and will not provide access to production data.

Once your integration has been successfully verified in staging (see the Staging Integration Test section below), a Prodege representative will provide you with production credentials.

Staging Integration Test

The process for handing off production credentials involves first validating your integration in staging by completing the following steps:

1. Register a panelist with demographic information using /register-user or via survey click into a survey returned by /get-surveys-for-vendor.

2. Click into a survey returned by /get-surveys-for-user or /get-surveys-for-vendor.

Once you've completed these steps, please contact [email protected] and provide the registered VPID and Project ID of the survey click. We'll then provide you with your production credentials and instructions on next steps.