API Lifecycle Policy
We provide an API endpoint to the Copaco Cloud platform, allowing our partners to extract data or process tasks in an automated way. In this knowledge base, we explain the endpoint we have, its status, and what you can expect regarding lifecycle, support, fixes, and additional feature development.
New API endpoints
Whenever we expose new functionality via our APIs, we release a new endpoint. Each new endpoint will have a status assigned to inform our partners about the lifecycle status and the stability they can expect.
If new datasets can be added to an existing endpoint (version), we will implement data to existing endpoints if they are in the status of Development, Beta, or Stable. Stable APIs will only be extended with additional fields/data if this does not break the existing API structure. Your code should be able to handle field additions and changes in the sort order of fields returned.
On a production system that uses APIs inside automation/scripts that are not manually checked, we recommend using API versions considered “Stable”.
Development/Beta endpoints should be used only for manual operations or have datasets verified by a partner. These endpoints could contain data inconsistencies or have changes applied to the dataset at any time, including additions, renames, removals, or replacements of fields.
New Versions
API endpoint versions are replaced with new versions when new functionality, schema changes, or bug fixes require breaking changes to a previously stable endpoint version.
Once we replace a stable endpoint version with a new stable version, we will move the previously marked Stable version to a Deprecated status. It is advised to update your integrations to a new API version whenever you need new functionality or whenever the API falls into the Deprecated status.
We keep supporting all API versions until the end of life has been announced. End of life is typically reached 6 months after an endpoint version is marked as Deprecated.
Current Endpoint Status
Endpoint | Version | Release Date | Status | End of Life Date |
---|---|---|---|---|
Billing APIs | ||||
Get Invoices | v1 | November 2023 | Stable | N/A |
Get Example Invoices | v1 | November 2023 | Stable | N/A |
Get Customer Specifications | v1 | January 2024 | Stable | N/A |
Subscription APIs | ||||
Get Customer Subscriptions | v1 | February 2024 | Beta | N/A |
Catalog API | ||||
Get Products | v1 | April 2024 | Development | N/A |
Get Offers | v1 | June 2024 | Development | N/A |
Get Price | v1 | July 2024 | Development | N/A |
Organizations API | ||||
Get Customers | v1 | July 2024 | Development | N/A |
Create Customer | v1 | July 2024 | Development | N/A |
Update Customer | v1 | September 2024 | Development | N/A |
Activate Customer | v1 | September 2024 | Development | N/A |
Status explanation
Status | Description | Support | Bugfix Releases | Feature Additions |
---|---|---|---|---|
Development (experimental) | Endpoints in the Development status are currently under development and are subject to (major) changes without notice. You can use the latest features and fixes, but the API might have inconsistent data and low performance. Use case Support and Documentation | Limited | Yes | Yes |
Beta | Endpoints in the Beta status have all planned functionality implemented, but data consistency and performance should still be monitored closely. Use case Support and Documentation | Limited | Yes | Yes, but limited |
Stable | Endpoints in the “Stable” status are ready for production use in your automated systems. Use case Support and Documentation | Yes | Yes, but limited | Yes, but limited |
Deprecated | Endpoints in the Deprecated status are superseded by a new version. The endpoint will be phased out within 6 months on the end-of-life date. We recommend everyone upgrade to a new API version. Use case Support and Documentation | Yes | No | No |
End-Of-Life | Endpoints that passed the end-of-life after its 6-month deprecated status will be shut down. Copaco will proactively contact partners using these endpoints to warn them about the imminent API shutdown. | No | No | No |
Did you find an issue, or require functionality not listed in the above table? Contact our support team via https://support.copaco.cloud or submit feedback via https://feedback.copaco.cloud.