Global cloud platform
Public API and unified error codes
- Area
- SaaS platforms
- Customer
- Quadient
Standardising the public interfaces shortened customer integration and gave developers a predictable way of handling errors.
Solution goal3 daysintegration instead of 3 weeks
Solution goal15 minto the first working connection
Scope≈ 4,000unified error states
Starting point
What needed to change
The products used different approaches to naming, versioning and returning errors. A new integration therefore took up to three weeks, and changes could break backward compatibility.
Our responsibility
How we approached the solution
We designed a company-wide REST API standard with rules for naming, versioning, deprecation and breaking changes. At the same time we unified approximately 4,000 application and infrastructure error states.
Part of the delivery
A complete scope
- API standard and governance
- Asynchronous public API
- Versioning and deprecation strategy
- Error model across application and infrastructure
Impact
What the customer gained
- The standard was designed to cut the integration of a new customer from three weeks to three days.
- A first working connection was meant to be demonstrable within 15 minutes.
- The rules became the basis for rewriting further APIs.
Technologies and approaches
- REST API
- Asynchronous processing
- Cloud
- API governance