Versioning
The openPIM API follows a versioning scheme to manage changes and updates over time. This ensures compatibility with existing client implementations while allowing for the introduction of new features and improvements.
Current Version
The current version of the openPIM API is v1.
- Base URL: `https://api.openpim.io/v1`
- GraphiQL Playground: https://api.openpim.io/v1/graphiql.
- REST Swagger Documentation: https://api.openpim.io/v1/documentation/rest/ .
Future Versions
The next planned version of the openPIM API is v2. You can monitor the Next Release page to see what is comming.
- Future Base URL: `https://api.openpim.io/v2`
Version Lifecycle
When a new version of the API is released, the previous version will be maintained for a period of one year before being deprecated. During this time, both versions will remain accessible, allowing clients to migrate to the new version at their own pace. After the one-year period, the legacy version will be deprecated, and clients will need to update to the latest version. Deprecated versions of the API will no longer be accessible.
Updating Clients
When a new version of the API is released, clients are encouraged to update their integrations to take advantage of new features and improvements. Detailed release notes and migration guides will be provided to assist with the transition.
Feedback and Suggestions
We value feedback from our users and welcome suggestions for improving the openPIM API. If you have any questions, concerns, or ideas for future versions, please don't hesitate to reach out to support.