Getting Started
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.
Staging Environment
The Prodege API has a staging environment that can be used for testing integration with test user accounts. 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.
Base URLs
Base URL for Prodege API requests to Staging Environment:
https://surveypmr.prodegeapisqa.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
Kick-off call with Prodege API Support Team
Integrate API methods. At minimum, the Project Calls and Quota Calls must be integrated
Integrate Transaction Completion method
Integrate Transaction Reconciliation methods
Perform complete integration test against the Staging environment (see Staging Integration Test below)
Receive production credentials
Run single-project full cycle test
Production evaluation call with Prodege API Support Team
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.
Project is set to a LIVE status
Contains at least one quota
Successfully redirects to a DQ status
Successfully redirects to a Complete status
Contains buyer_name
Aggregate Conversion is passed (via Update Aggregate Stats by Project)
Aggregate Completes is passed (via Update Aggregate Stats by Project)
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.
Last updated