- Print
- DarkLight
- PDF
API Gateway is a service that sits between a client (application, service) and Corezoid API. It acts as a reverse proxy: accepts tasks from clients, forwards them to Corezoid, receives processing results and sends responses back to clients. This architecture allows hiding Corezoid API details from the outer world, providing clean API specifications and URLs to end users.
API Gateway allows users to create their own APIs and multiple unique paths within each API to send data from applications or any API-enabled services to Corezoid with the specified parameters and receive processed data (depending on the operation mode).
API Gateway performs functions similar to Sync API but provides broader configuration possibilities and the ability to create publicly available APIs (signature is not mandatory).
An example of API Gateway use
In this scenario, API Gateway (api gw) is used as a tool that receives data input from a WebApp (initiated by a user via a Telegram bot) and forwards it to a Corezoid process in a task with specified parameters. After the task is processed in Corezoid API Gateway sends the results back to the WebApp for further processing on the Server.