API Environments
Our API is accessible across multiple environments. Each environment is tailored to different stages of the software development and deployment lifecycle. Below is a description of each environment and guidance on how to use them effectively.
Development Environment
https://dev.api.circulor.io
Swagger: https://dev.api.circulor.io/swagger/index.html
OAuth2 : https://dev.auth.circulor.io/oauth2/token
The development environment is designed for testing new features and experiments. It is less stable but updated frequently to include the latest changes and features. This environment should be used for development testing only, as data can be reset or changed without notice.
UAT Environment
https://uat.api.circulor.io
Swagger: https://uat.api.circulor.io/swagger/index.html
OAuth2 : https://uat.auth.circulor.io/oauth2/token
The UAT (User Acceptance Testing) environment is where new features are stabilized before being released to production. This environment should be used for pre-release testing to validate new features and bug fixes under conditions that closely simulate the production environment.
Demo Environment
https://demo.api.circulor.io
Swagger: https://demo.api.circulor.io/swagger/index.html
OAuth2 : https://demo-prove-ingestion.auth.eu-central-1.amazoncognito.com/oauth2/token
The Demo environment is a production like environment, but with a limited number of users and data. It is used for demonstrations and demonstrations.
Production Environment
https://api.circulor.io
Swagger: https://api.circulor.io/swagger/index.html
OAuth2 : https://auth.circulor.io/oauth2/token The production environment is our live environment where stable, tested, and approved changes are available. This environment should be used for all real operations and when integrating with production systems.
Interactive API Documentation
Below is the interactive API documentation powered by Swagger UI, which allows you to explore the API and test the endpoints directly from your browser.