Everything API Maker serves sits behind one base URL and one token header. A table gets its APIs twice: under /api/schema, where every write goes through the schema of the table, and under /api/gen, where data passes as it is. Your own code answers under /api/custom-api, and the ready-made APIs under /api/system-api.
/apibase/schemaor /gen/adminyour path/shopinstance/maindatabase/productstable/countoperation
/api/schema and /api/genAPIs of every table
The same 17 operations under both. MongoDB gets all 17 ; MySQL, MariaDB, PostgreSQL, SQL Server, Oracle, TiDB and Percona get 14, without the 3 marked MongoDB.
| Operation | Method | Path after the table |
|---|
| Get all | GET | / |
| Get all by stream | GET | /stream |
| Get by id | GET | /get-by-id/:id |
| Save single or multiple | POST | /save-single-or-multiple |
| Master save | POST | /master-save |
| Update by id | PUT | /update-by-id/:id |
| Update many | PUT | /update-many |
| Replace by id MongoDB | PUT | /replace-by-id/:id |
| Array operations MongoDB | PUT | /array-operations |
| Remove by id | DELETE | /:id |
| Remove by query | POST | /query/delete |
| Query | POST | /query |
| Query by stream | POST | /query-stream |
| Aggregate MongoDB | POST | /aggregate |
| Count | POST | /count |
| Distinct | GET | /distinct/:field |
| Distinct with query | POST | /distinct/:field |
/api/custom-apiYour own APIs
A function in TypeScript, Python, PHP, C#, Go, Rust, Java or Kotlin, behind the path and method of its settings.
POST /api/custom-api/admin/order-total
Custom APIs wss://WebSockets
On the port of the APIs. Apps connect with their tokens and register for the APIs of a table, a custom API, a system API or an event of their own.
WebSockets /api/system-api23 ready-made APIs, all POST
Closed to outside callers until their settings open them, except /token. Your code calls every one of them through g.sys.
Security
/token/encrypt-data/decrypt-data/hash-data/get-secret-by-name
Redis and cache
/get-redis-key/set-redis-key/remove-redis-key/reset-redis-cache-db/reset-redis-cache-custom-apis/reset-redis-cache-system-apis
Databases
/get-table-meta/execute-plain-query/create-indexes/drop-indexes/get-indexes/is-valid-connection-string/multi-tenant-instance-updated
Events
/emit-event/emit-event-ws
Validation
/is-valid-data-for-table/is-valid-data-for-custom-api
Every operation, with its body, query params and answers : All APIs at a glance.
