Why it matters: APIs are contracts. We treat them that way.
APIs you can rely on.
Clear contracts, predictable behavior, and stable integration paths.
What's available.
ServiceBricks REST
Full CRUD, patch, query, and validation for every generated service.
ServiceQuery
Polyglot querying across all database engines with one syntax.
MCP Integration
A standard way to connect AI tools safely to your services.
Authentication & permissions.
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.
Common patterns.
| Use Case | Method | Endpoint Pattern |
|---|---|---|
| Create entity | POST |
/api/v1/{entity} |
| Get by key | GET |
/api/v1/{entity}/{storageKey} |
| Query | GET |
/api/v1/{entity}/query |
| Update | PUT |
/api/v1/{entity} |
| Delete | DELETE |
/api/v1/{entity}/{storageKey} |
storageKey is the universal identifier across all entities.
Stability guarantees.
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 Messages
Clear, actionable error messages you can parse and display.
Consistent Structure
Same error format across all endpoints. No surprises.
Rate Limits
Clearly documented limits with helpful headers.