Skip to content

API Maker Documentation

System APIs

System APIs

👉 API Maker provides intellectual system APIs to do your work smartly.

👉 Code Panel

User can take advantage of all system API of API Maker inside the code of custom API, scheduler, events etc....

👉 Auto suggest Payload

The user can generate payload with a single click by using Generated Data option in body section.

⭐ List of System APIs ⭐

✅ Encrypt data

Encrypt the plain text from the data property and output the encrypted string, with the help of encryption credential from secret.

✅ Decrypt data

Decrypt the encrypted string from the data property and output the original text, with the help of encryption credential from secret.

✅ Hash data

Use the hashingAlgorithm and nonce from secret management to hash the text from the data property and output the hash value.

✅ Get Token

This allows us to obtain the token of the API_user and the application_user.

✅ Call external API

API Maker support two type of call external API
Parallel - The external APIs are executed simultaneously when the type is 'parallel'.
Sequential - The external APIs are executed one after another when the type is 'sequential'.

✅ Get secret key/keys

This API, get value of key which saved on the secret management.
Moreover, the business requirement specifies that the user can access the value of the key stored in the secret management.

✅ Set redis key/keys

Assign the string value to the key.
If key already holds a value, it is overwritten, regardless of its type.
The key`s any previous time to live (TTL) associated with the key is discarded on successful SET operation.
Using an array user can set more than one key at a time.

✅ Get redis key/keys

Return the key's value.
If the key does not exist, return nil.
If the key's value is not a string, return an error, because GET only handles string values.
Using an array user can get more than one key at a time.

✅ Remove redis keys/keys

Removes the specified keys.
If the key does not exist, it is skipped.
It accepts one argument, which is the key to delete.
Using an array user can remove more than one key at a time.

✅ Reset database cache

Reset the cache of specific instance, database, collection.

✅ Reset third party API cache

Reset the cache of specific third party API.

✅ Reset custom apis cache

Reset the cache of specific custom API.

✅ Reset system apis cache

Reset the cache of specific system API.

✅ Get table meta data

It will help to create migration script and very useful to check the status of a specific table.
It provides information about the schema structure, field type, original database type, validations and more.

✅ Emit event

With API Maker, you can create N-number of listeners as you want with event data arguments to trigger an event.
API Maker does not have any limit on creating events.

✅ Emit event WS

This API useful to emit WS event and to notify the user who are listening on that WS event through an api call.

✅ Is valid data for table

This API validates the given data against the database schema and checks if they have valid values.
It does not validate foreign keys/primary keys or database errors, such as indexing related errors.

✅ Is valid data custom API

This API validates the given data against the custom API Schema and checks if they have valid values.

✅ Is valid data for third party API

This API validates the given data against the third-party API schema and checks if they have valid values.