Thanks for your feedback!
EDIT
What is the "Manager" API and how should I (and shouldn’t) use it?
The Sensedia "Manager" API allows our customers to apply API design-time settings via HTTP calls.
To better understand, see the simplified API Platform diagram:
-
The gateway receives and handles app calls, routes them to the correct servers, and returns responses to each app. This process is part of the API runtime, which we call the data plane.
-
During runtime, the gateway applies the settings defined in the API design, which happens in the control plane. In our case, these settings are defined on the API Manager, the graphical interface of the Platform.
-
On the API Manager, you define how the gateway should behave. For example, you can specify that an API will only accept access tokens generated by the Authorization Code flow of OAuth, or that an API will have a call rate limit per minute. These settings are sent to the gateway and applied at runtime.
The "Manager" API allows these control plane settings to be made via HTTP calls, instead of exclusively in the graphical interface. This is useful for CLI configurations or CI/CD automations during the API design-time.
The separation between control plane and data plane is essential for the stability and scalability of the ecosystem. Therefore, the "Manager" API should only be used as a design-time tool.
| Never include calls to the "Manager" API in the productive flow of another API. Doing so overlaps the control plane and data plane and can cause API instability, such as call timeouts or high latency. |
Share your suggestions with us!
Click here and then [+ Submit idea]