Using Circularo API Documentation
Begin your journey with Circularo APIs by understanding the essentials of API testing. This is crucial for seamless integration and utilisation of Circularo functionalities.
We highly recommend to use Postman as a testing tool to our API. For ease of use, we provide a downloadable collection in our Postman guide.
Prerequisites
Before you dive into integrating with Circularo, make sure you
understand HTTP methods and have some previous experience with RESTful APIs
are familiar with JSON structures
have an active Circularo account
If you don’t have active Circularo account, sign up for Trial or send a request to our sales team for dev environment access.
Requests
Our API accepts requests in Content-Type: application/json format.
Examples highlight only the most crucial properties for clarity. Additionally, any required parameters are marked in bold to help you identify them quickly. For a more comprehensive overview of all available properties and parameters, you can refer to our detailed Circularo REST API Swagger documentation.
Navigation and understanding of Documentation
Navigation Tips:
Table of Contents: Utilize the table of contents for a structured walkthrough of the documentation.
Links & References: Throughout the documentation, you'll find links to related sections or external resources. They're there to provide deeper insights or clarify context.
Quick Access Bar: Use the quick access bar for fast jumps to commonly accessed sections.
Searching Efficiently:
Use specific keywords or phrases related to your query.
Take advantage of code snippets and examples for practical understanding.