Skip to main content

Changelog

May 2026 — API Restructure​

  • API groups are now capability-based, not regulation-based
  • New Compliance API — risk assessments shared across EUDR, PPWR, and EUTR
  • New Data API — documents, imports, RAG queries, financial transactions
  • Supply Chain API expanded with traceability (DDS, trace-orders, traces)
  • New PPWR Compliance use-case guide
  • EUDR Compliance API retired as a standalone group — now a use-case guide

October 2024 — Initial Release​

Initial Release​

  • Created 4 curated API specifications from 238 source endpoints
  • Organized by product area (EUDR, Supply Chain, Carbon, Accounts)
  • Applied Coolset brand styling
  • Removed API versioning (no version numbers in URLs or specs)
  • Removed boilerplate examples (museum API)

APIs Created​

  • Supply Chain API - 23 endpoints for order and supply chain management
  • EUDR Compliance API - 13 endpoints for regulatory compliance
  • Carbon API - 3 read-only endpoints for emissions data
  • Accounts API - 4 endpoints for user and workspace management

Design Decisions​

  • No API versioning - maintain backward compatibility instead
  • Product-focused organization (not service-focused)
  • Coolset brand colors: Green (#2E7D32) for sustainability
  • Read-only Carbon API to prevent accidental data modification
  • Multi-API Redocly setup for easy navigation

Technical Details​

  • Converted from Swagger 2.0 to OpenAPI 3.0
  • Source APIs: Pulse, Scranton, Coolset
  • Node.js requirement: >= 20.19.0 for full features
  • Documentation optimized for AI-assisted development

Future Changes​

Document all API changes here following semantic versioning principles:

  • Breaking changes - Require user action
  • New features - Backward compatible additions
  • Bug fixes - Backward compatible fixes
  • Documentation - Docs-only updates

Note: While we don't version our API URLs, we track changes here to maintain transparency and help users understand what changed.