Developer Guide
Environments
Base URLs for the Demo and Production environments, and how to promote an integration.
The Propelus API is available in two environments. Both expose the same /v2 endpoints; only the base URL, and possibly your credentials, changes.
Base URLs
| Environment | Base URL | Use it for |
|---|---|---|
| Demo | https://api.demo.propelus.com | Development, testing, and integration work. |
| Production | https://api.propelus.com | Live traffic against real credential data. |
All examples in these guides use the Demo base URL. To call Production, swap the host and keep the path identical:
# Demo
curl https://api.demo.propelus.com/v2/professions ...
# Production
curl https://api.propelus.com/v2/professions ...About the Demo environment
TBD, API team to confirm. Document the Demo environment's behavior so integrators know what to expect:
- Does Demo return synthetic/sample data or real primary-source data?
- Are credentials issued separately for Demo and Production? (See Authentication.)
- Is Demo data reset on a schedule?
- Are there any endpoints or features that behave differently in Demo?
Going live
When you're ready to move from Demo to Production:
- Swap the base URL from
https://api.demo.propelus.comtohttps://api.propelus.com. - Swap credentials if required. Confirm whether your Demo
x-api-key/x-client-idalso work in Production (see the TBD above). - Re-register webhooks. Webhook registrations are scoped to the environment they were created in, so any webhooks you set up in Demo must be re-created against Production. See the Webhooks guide.
- Confirm error handling and backoff are in place. Review Errors and Rate limits.