APIs you can rely on.
Clear contracts, predictable behavior, and stable integration paths.
Why it matters: APIs are contracts. We treat them that way.
Authentication & permissions.
Secure by default, flexible when you need it.
Token-Based
JWT authentication for API access.
Role-Based
Access control with granular roles.
Scope-Limited
Permissions are explicit, not implicit.
Auth Required
Write operations always authenticated.
Use the ServiceBricks® Security microservice to provide a secure foundation for your APIs.
Common REST API patterns.
Consistent endpoints across all generated services.
| Use Case | Method | Endpoint Pattern |
|---|---|---|
| Create | POST |
/api/v1/{Module}/{Entity} |
| Create (Ack) | POST |
/api/v1/{Module}/{Entity}/CreateAck |
| Update | PUT |
/api/v1/{Module}/{Entity} |
| Update (Ack) | PUT |
/api/v1/{Module}/{Entity}/UpdateAck |
| Patch | PATCH |
/api/v1/{Module}/{Entity} |
| Patch (Ack) | PATCH |
/api/v1/{Module}/{Entity}/PatchAck |
| Get by key | GET |
/api/v1/{Module}/{Entity}/{storageKey} |
| Query | POST |
/api/v1/{Module}/{Entity}/Query |
| Delete | DELETE |
/api/v1/{Module}/{Entity}/{storageKey} |
| Validate | POST |
/api/v1/{Module}/{Entity}/Validate |
storageKey is the universal identifier across all entities. Ack methods return only success disposition—no entity data—for smaller response payloads.
Stability guarantees.
APIs are contracts. We treat them that way.
Versioning policy: Breaking changes are reserved for major versions. We provide deprecation notices in advance where possible.
Backwards compatibility: A design goal, not an afterthought. We test against previous versions.
Migration guides: When major versions do ship, clear documentation for the upgrade path.
Error handling.
Predictable errors you can handle programmatically.
Predictable Messages
Clear, actionable error messages you can parse and display.
Consistent Structure
Same error format across all endpoints. No surprises.
Auditable Events
Clear audit trails with local or centralized logging.
Use the ServiceBricks® Logging microservice for application diagnostic logging and web request message auditing.
API commitments.
Our promises for API behavior.
What We Do
- Publish changelogs
- Provide deprecation notices
- Maintain backwards compatibility
Boundaries
- No silent breaking changes
- No undocumented behavior
Control
- Version selection where applicable
- Clear migration guides for major versions
Questions? See Enterprise options or contact us.