API Documentation

  1. Overview
  2. Getting Started
  3. Authentication
    1. Request Expiration
    2. Request Signing
    3. IP Whitelisting
    4. Link Signing
  4. API Reference
    1. Lookup Calls
      1. Lookup Request Time Offset
      2. Lookup All Supported Countries
      3. Lookup Questions By CountryID
      4. Lookup Postal Code Questions By CountryID
    2. Feasibility Calls
      1. Run Feasibility
      2. Run Feasibility by Project
    3. Project Calls
      1. Create Project
      2. Update Project
      3. Delete Project
      4. Duplicate Project
      5. Project Settings - Update
      6. Get Project Settings
      7. Update CPI
      8. Project Multi-Links
      9. Get Project Info
      10. Get Stats By Project
      11. Get Quotas By Project
      12. Get Project List
      13. Update Aggregate Stats by Project
    4. Quota Calls
      1. Create Quota
      2. Update Quota
      3. Delete Quota
    5. Recontact Calls
      1. Recontact by Panelist
      2. Recontact by Transaction
      3. Get Recontact List
      4. Remove Recontact Entries
    6. Project Transaction Calls
      1. Transaction Completion
      2. Transaction Reconciliation
      3. Create Project Transaction
      4. Lookup Transaction Status
      5. Lookup Multiple Transaction Statuses
  5. Test Project URL
  6. Webhooks
    1. Real Time Pricing
  7. Appendix
    1. JSON Examples
    2. Collecting User Data
    3. Real Time Pricing Overview
    4. Project Types
    5. Error Codes
    6. FAQ

2.Getting Started

Acquiring API Credentials

Before using the Prodege API you must acquire a unique API Key and Secret Key. These keys will be used to authenticate your requests to the Prodege API. Details regarding request authentication can be found in the Authentication section of this document. To acquire your API credentials, contact apisupport@prodegemr.com

Staging Environment

The Prodege API has a staging environment that can be used for testing integration with test user accounts.

Staging Prodege user API Key:

dnMHmAcdsrGqviJ

Staging Prodege user Secret Key:

aZXK1cbmAGZ5sUqS8GKs8QSH0FIaUtChurlSCqYIx7LjyZIMEZPivA8HQn6ZwQX10

Base URL for Prodege API requests to Staging Environment:

https://prodegemr.sbxdv.com/prodegemr

Base URL for Prodege API requests to Production Environment:

https://surveypmr.prodegeapis.com/prodegemr

Important Note:

When directing users to an endpoint, as well as when making calls to an endpoint, please be sure to utilize the secure HTTPS protocol. Using HTTP may lead to compatibility issues, especially on mobile devices, and is not recommended for a seamless experience.

Pre-launch Checklist

  1. Kick-off call with Prodege API Support Team
  2. Integrate API methods. At minimum, the Project Calls and Quota Calls must be integrated
  3. Integrate Transaction Completion method
  4. Integrate Transaction Reconciliation methods
  5. Perform complete integration test against the Staging environment (see Staging Integration Test below)
  6. Receive production credentials
  7. Run single-project full cycle test
  8. Production evaluation call with Prodege API Support Team
  9. Launch integration

Staging Integration Test

Before receiving production credentials, the integration must first be verified in staging. To do so, please create and share with Prodege API Support the prodege_project_id of at least one project in staging that meets the criteria below. 

  1. Project is set to a LIVE status
  2. Contains at least one quota
  3. Successfully redirects to a DQ status
  4. Successfully redirects to a Complete status
  5. Contains buyer_name
  6. Aggregate Conversion is passed (via Update Aggregate Stats by Project)
  7. Aggregate Completes is passed (via Update Aggregate Stats by Project)
  8. Once we are able to verify the criteria above, we will also ask that you reconcile at least one transaction (via Transaction Reconciliation) and update the status of the Project to COMPLETE.
« OverviewAuthentication »
Help Guide Powered by Documentor
Suggest Edit