Creating an API
NocodilySuite lets you create three types of APIs.
Choose the appropriate type for your use case — simply define it in the console and the API is built automatically.
| API Type | Purpose |
|---|---|
| IAM API (Authentication API) | Foundation for user auth, organization management, RBAC, and SSO |
| MicroService API | REST API for business logic and data management |
| Storage API | Upload/download for files, images, and videos |
Creating an IAM API
- Select a team in the console.
- Click "API" > "Create New API".
- Select "IAM API".
- Configure the following settings:
| Field | Description |
|---|---|
| API Name | An identifier name (e.g., production-auth) |
| Environment | TestEnv / DevelopEnv / StagingEnv / ProductionEnv |
| Database Engine | In-Memory (for testing) or Postgres (persistent) |
| Initial Admin Email | Email address for the first AdminUser |
| Initial Admin Password | Password for the first AdminUser |
- Click "Create".
After creation, the OpenAPI specification will be available in the console.
See Authentication Infrastructure API (IAM API) for full specifications.
Creating a MicroService API
- Select a team in the console.
- Click "API" > "Create New API".
- Select "MicroService API".
- Configure the following settings:
| Field | Description |
|---|---|
| API Name | An identifier name (e.g., inventory-api) |
| Environment | TestEnv / DevelopEnv / StagingEnv / ProductionEnv |
| Database Engine | In-Memory (for testing) or Postgres (persistent) |
| Auth Integration (optional) | Select an IAM API to enable authentication and RBAC |
-
Define the data schema:
- Set endpoint names, field names, and field types
- Specify whether each endpoint requires authentication
-
Click "Create".
After creation, CRUD endpoints are automatically generated.
See MicroService API for full specifications.
Creating a Storage API
- Select a team in the console.
- Click "API" > "Create New API".
- Select "Storage API".
- Configure the following settings:
| Field | Description |
|---|---|
| API Name | An identifier name (e.g., file-storage) |
| Environment | TestEnv / DevelopEnv / StagingEnv / ProductionEnv |
| Storage Engine | Local Storage (for testing) or Object Storage (persistent) |
| Auth Integration (optional) | Select an IAM API to enable authentication and access control |
- Click "Create".
After creation, upload and download endpoints are automatically generated.
See Storage API for full specifications.
After Creating an API
The following are available for any created API in the console:
- View OpenAPI spec: Browse the auto-generated interface specification
- Run tests: Send API requests from the console and inspect responses
- Version management: Safely update via Upgrade and Rollback
- View logs: Access access logs and error logs directly from the console