MicroService API
MicroService API is a mechanism for building REST APIs for business logic and data management.
Simply define data structures (schemas) in the console and CRUD operation endpoints are automatically generated.
It comes with all the features needed for a full-featured business API, including authentication, data joins, and custom logic.
By building multiple MicroService APIs in a single system, each with its own dedicated database,
you can achieve an architecture where services are kept small and the impact of changes is minimized.
Schema Definition and API Auto-Generation
Building a MicroService API starts with schema definition in the console.
- Set the endpoint name
- Define fields (columns) and their types (string, number, date, boolean, etc.)
- Configure whether authentication is required for each endpoint
Endpoint Name Obfuscation
Endpoint names are used in the actual URL paths accessed from outside.
If you don't want to expose names that reveal business context, you can obfuscate the endpoint name.
When obfuscation is enabled, the name set in the console is used only for internal management,
and the externally exposed URL is replaced with a random identifier.
Provided Interfaces
Once the definition is complete, REST API endpoints for the following operations are automatically generated.
| Operation | Description |
|---|---|
| List | Retrieve all records (supports search and paging) |
| Get One | Retrieve a single record by ID |
| Count | Get the count of records matching conditions |
| Exist | Check if records matching conditions exist (true / false) |
| Create | Create a single new record |
| Bulk Create | Create multiple records at once |
| Update | Update a single specified record |
| Bulk Update | Update multiple records at once |
| Delete | Delete a single specified record |
| Bulk Delete | Delete multiple records at once |
Each endpoint can be configured with one of the following three access settings.
| Setting | Overview |
|---|---|
| Admin only | Exposed as an Admin endpoint accessible only by admin users |
| Public (no auth) | Exposed as a public endpoint accessible without authentication |
| Organization scope | Accessible by authenticated users, restricted to data within the user's own Organization |
Access Control (Integration with IAM API)
You can choose whether to enable authentication and authorization per endpoint.
When authentication is enabled, the following controls are applied in conjunction with the IAM API.
- User Authentication — Only users holding an IAM API token are permitted access
- RBAC — Access is controlled based on the Role / Permission defined in the IAM API
- Organization Scope — Restrict operations to data belonging only to the user's own Organization
- Admin Endpoint — Enable a dedicated endpoint accessible only to administrator users
Database
MicroService APIs can use two types of database engines depending on the environment.
| Engine | Use Case | Features |
|---|---|---|
| In-Memory | TestEnv / DevelopEnv | No persistence. Data resets on restart. Ideal for testing, development, and demos |
| PostgreSQL | StagingEnv / ProductionEnv | With persistence. Relational database suitable for production |
Each MicroService API is provisioned with its own dedicated database, so data from other APIs is never mixed in.
Data Joins (Relations)
You can build APIs that join multiple schemas via relations.
For example, by configuring the orders schema to reference the users schema,
you can auto-generate an API that returns order information combined with user information.
Relations between schemas can be configured in the console — no hand-written SQL queries required.
Data Analytics Index
An analytics index feature is provided that lets you aggregate, filter, and visualize data directly in the console.
You can review accumulated data in real time from the console without building a separate API.
Custom Code (Embed Code)
Business logic that cannot be handled by schema definitions alone can be extended with Custom Code (Embed Code).
By inserting custom code into the "pre-processing" or "post-processing" of an endpoint,
you can add any processing you need, such as data validation, external API calls, or notification sending.
See Custom Code (Embed Code) for details.
OpenAPI Specification Auto-Generation
The OpenAPI specification for the endpoints you build is automatically generated in the console.
It can be used for sharing specifications with frontend teams or external integration partners, and for auto-generating TypeScript client SDKs.
Version Management
All MicroService APIs are versioned.
Upgrades when reflecting changes to production and rollbacks when problems occur can both be executed from the console.
See Upgrade / Rollback for details.
Interface
MicroService APIs are provided as standard HTTP/1.x REST APIs.
They can be connected from anywhere that has an HTTP client — existing systems, frontends, external services, or AI Agents.