Transforming Bugcrowd API Architecture for a Better Developer Experience
We are excited to announce significant improvements to our API architecture, designed to enhance performance, simplify usage, and streamline future updates. These enhancements include:
- Structural Improvements: Reducing the dependency on deeply nested includes for more efficient calls.
- New Serializers: A new set of serializers to eliminate complex queries and significantly boost performance.
- Versioning System Fix: Transitioning from a date-based versioning system to a semantic versioning (SemVer) system. This change removes the need for serializer transformers, simplifying the developer process and improving stability.
Consolidation of Versions
As a result of these improvements, all current date-based API versions will be consolidated into a single major API version, V1. This V1 version will be backward compatible with all existing date-based API versions. Customers currently using a date-based version will be automatically migrated to V1, and their API keys will be updated accordingly, requiring no action on their part.
Versioning and API Keys
- API keys will be pinned to a major release (starting with V1).
- New features and bugfixes will be delivered as transparent point releases, maintaining backward compatibility within the major release.
- There are no changes to the current API functionality.
The improved versioning system will facilitate faster and more efficient delivery of new API features to customers.
Next Steps
These API changes will be communicated to current API customers and rolled out over the next month. A customer-facing technical blog post with more details will be available soon.
