Skip to content

Welcome to Circulor API Documentation

Introduction

Welcome to the comprehensive documentation for Circulor's APIs. This site serves as the central hub for developers seeking to integrate with our suite of services. Whether you're looking to automate processes, enhance functionality, or build new applications, our APIs provide the tools you need to achieve your goals efficiently.

Our APIs

At Circulor, we offer a range of APIs that cater to different aspects of our services:

  • PROVE Ingestion: Service for ingesting traceability and product data either via API or via SFTP
  • Digital product passport: Service for accessing digital product passports

Each section of our documentation is dedicated to a specific API. You will find detailed information on how to get started, authentication methods, available endpoints, and examples to help you make the most of our APIs.

Getting Started

To begin using our APIs, we recommend the following steps:

  1. Choose the API: Select the API that best fits your needs from the list above.
  2. Read the Overview: Each API has its own overview section that introduces you to the capabilities and requirements.
  3. Set Up Authentication: Ensure you understand the authentication process as it is crucial for accessing our services securely.
  4. Experiment with Endpoints: Explore the endpoints available for your chosen API to understand how they can be integrated into your applications.

Click here to get started with the PROVE Ingestion API.

Support

Should you encounter any issues or if you have questions, please consult our Support Page or contact our technical support team at support@circulor.com. We are here to help ensure your integration process is smooth and successful.

Feedback

Your feedback is vital in helping us improve our documentation and services. Please let us know if there are areas we can enhance or additional features you require. You can submit feedback directly through our site or by contacting our support team.

Thank you for choosing Circulor. We look forward to supporting your integration and helping you succeed with our APIs.