Staging Environment
What is the Staging Environment?
What is the Staging Environment?
The Staging environment is a safe, simulated version of the Embedly API,
designed for testing and development. It mirrors the Production environment in
terms of functionality and API behavior, but with one key difference: actions
performed in the Staging do not affect real data or financial transactions.
Why Use the Staging Environment?
Why Use the Staging Environment?
- Safe Testing: The Staging allows you to test your integration without the risk of impacting real users or data. You can freely experiment with API calls, validate your workflows, and troubleshoot issues in a controlled setting.
- Development Flexibility: Use the Staging to build and refine your application, ensuring all API interactions function as expected before going live.
How to Access the Staging Environment
How to Access the Staging Environment
To start using the Staging environment, direct your API requests to the
following base URL:
Best Practices for Using the Staging
Best Practices for Using the Staging
- Test Thoroughly: Before moving to Production, ensure you’ve tested all possible scenarios in the staging, including Embedly cases and error handling.
- Simulate Real-world Conditions: Mimic the conditions your application will face in Production as closely as possible to uncover potential issues early.
Production Environment
What is the Production Environment?
What is the Production Environment?
The Production environment is where your application interacts with real users
and live data. Once your integration has been thoroughly tested in the
Staging, you’ll transition to Production to begin live operations.
Why Use the Production Environment?
Why Use the Production Environment?
- Live Operations: This environment is for real transactions, data processing, and user interactions. Everything that happens here is part of your live service, affecting actual business operations.
How to Access the Production Environment
How to Access the Production Environment
Once you’re ready to go live, switch your API requests to the following base
URL:
Best Practices for Using the Production Environment
Best Practices for Using the Production Environment
- Ensure Readiness: Double-check that all tests have been completed in the Staging, and that your integration is fully prepared for live use.
- Monitor Performance: Keep a close eye on your application’s performance in Production, particularly in the initial phase, to quickly identify and address any issues.
Transitioning from Staging to Production
1
Final Testing in Staging
Perform a final round of testing in the Staging to ensure all functionality
works as intended.
2
Update Configuration
Modify your application’s configuration to point to the Production
environment URL. Ensure that api key and
environment-specific settings are updated accordingly.
3
Perform a Controlled Launch
Consider rolling out your integration gradually in Production to monitor its
performance and make adjustments as needed.
4
Ongoing Monitoring
After moving to Production, continue to monitor your integration closely,
particularly in the early stages of deployment.
Important Considerations
Remember that your API key is environment-specific. Ensure that you are using
the correct api key for each environment to avoid authentication errors.
Always store your api key securely and follow best practices for API security,
especially in the Production environment.
Keep in mind that data in the Staging is separate from Production. Actions in
the Staging will not affect your live data or operations.