The API Gateway is an external open source MIT license middle-ware, enabling end users, apps and web pages to connect to Orchestra in a controlled and secure way, limiting the load on Orchestra, even for a large number of users. It can be seen as a front door for all requests from external devices and web sites to the Orchestra Central server, thus removing the need to expose the Central Orchestra server to internet. For this purpose, the API Gateway uses a Netflix module called Zuul.

The API Gateway can be used, for example, for geo-location attributes to locate available Branches and information about the Services that each Branch provides. Also, it is possible to get information about how many people that are waiting in line for each Service, at each Branch, and finally to take a ticket on a suitable Branch/Service.

The API Gateway can be deployed at the customer’s DMZ, or on an Orchestra server for evaluation purposes.

One of the following Orchestra versions is required for API Gateway to work correctly:

The recommended server setup for a standalone setup, with high load is:

Since API Gateway uses a number of connectors in Orchestra, you need to make sure that you have bought a correct Orchestra license, depending on how you want to use API Gateway.

For more information, see the Order and Orchestra sections on Qmatic World.

The API Gateway has a version number that consists of four digits, for example 1.3.4.0.

The version number is built up of the following components:

This means that if you create a customised version, you should increase the fourth digit of the version number, for example making it 1.3.4.1. This would be very helpful for the Support organisation, should you run into any problems with the API Gateway.

The recommended order of setting up API Gateway is as follows: