Docs

Metamug API Console is an API publishing and management platform that runs as an HTTP web server which can be deployed on Premise or on the Cloud. API Console enables the user to define and manage REST API endpoints that provide a layer of abstraction for your backend services including databases, third party API services, business logic, scripts and more.

API Console consists of the following components:
1. API console UI app: A browser based UI to manage the REST API resources and other services like Auth, monitoring, API client management, backend properties. This is the single point of interaction between the developer and the platform. 

2. API management services: API Management services are provided through the API Console UI app. These are as follows:

a. Authentication: API endpoints can be protected with role based authentication. User-role management is available on board. Alternatively third party oauth services can be integrated.

b. Request analytics, monetisation and throttling:

Incoming API request data is logged and is available on the analytics dashboard. The dashboard contains number of requests hitting the API per day, client device types, client operating systems, etc. 

Monetisation factor can be applied to the number of requests and rate limiting can be done by setting an upper limit to the number of requests.

c. Client App management:

Create multiple API keys for your API by creating client projects. The API keys allow you to track usage of your API by a particular client app on the analytics dashboard.

d. Resource management:

Every API endpoint is represented as a Rest resource. Resources can be created by entering a resource name (eg. pet). This name will appear in the API URL (/v1.0/pet). Versioning and authentication is done on the resource level.

The API workflow is designed using the mpath description language. The workflow involves calling different backend services, database queries, business logic invocation etc.

Deployment is instant. On saving your workflow, the API is deployed in seconds.

e. Documentation:

API documentation and open API spec for the API is generated live as soon as a resource is saved.

3. Business logic, scripting and plugins:

On board code execution engine can be used for running Java maven projects as plugins. Also Groovy scripting is supported.

Plugins and scripting are also useful for generating custom API responses, integrating third party Auth services or using SDKs to call external services like AWS S3 or Lambda.

4. Open source runtime - The runtime does the job of processing the incoming API requests. Source code is available on GitHub.

5. Backend services:

The API workflow allows calling third party API services, querying of databases, execution of business logic or scripts. Query management is available for SQL databases allowing testing, saving and re using of database queries.