Gateway Services Implementation Reference¶
The following sections document the implementation of the different endpoints exposed by the Envase Connect Gateway API.
Admin Services¶
This module contains the implementation of the administrative endpoints. Applications will rarely need to access this endpoints, but they provide useful status information to troubleshoot problems.
- get_about()¶
Returns the about information for the Gateway service. This includes the version that is currently deployed.
- get_config()¶
Returns configuration information for the Gateway service.
- register_blueprint(main_app)¶
Registers the admin blueprint with the main application.
Gateway Services¶
This module contains the implementation of the overarching endpoint that dispatches the requests to the correct TMS system. The endpoint supports all the HTTP methods, so it is up to the handling TMS to provide decide which methods should be supported for each request URL.
- dispatch_request(path)¶
Dispatches the request to the appropriate TMS and returns the received response.
- register_blueprint(main_app)¶
Registers the blueprint with the application.