O que é a API "Manager" e como devo (e não devo) utilizá-la?

A API "Manager" da Sensedia permite que nossos clientes façam configurações no design-time de APIs via chamadas HTTP.

Para entender melhor, veja o diagrama simplificado da API Platform:

data control plane
  • O gateway recebe e trata as chamadas das apps, envia para os servidores corretos, e retorna as respostas para cada app. Esse processo faz parte do runtime das APIs, que chamamos de data plane.

  • Em runtime, o gateway aplica as configurações definidas no design das APIs, que ocorre no control plane. No nosso caso, essas configurações são definidas no API Manager, a interface gráfica da Plataforma.

  • No API Manager, você define como o gateway deve se comportar. Por exemplo, pode definir que uma API só aceitará access tokens gerados pelo fluxo Authorization Code de OAuth ou que uma API terá limitação de chamadas por minuto. Essas configurações são enviadas ao gateway e aplicadas em runtime.

A API "Manager" permite que essas configurações de control plane sejam feitas via chamadas HTTP, ao invés de exclusivamente na interface gráfica. Isso é útil para configurações por CLI ou automatizações de CI/CD no design-time das APIs.

A separação entre control plane e data plane é essencial para a estabilidade e escalabilidade do ecossistema. Portanto, a API "Manager" deve ser usada apenas como uma ferramenta de auxílio de design-time.

Nunca inclua chamadas à API "Manager" no fluxo produtivo de outra API. Fazer isso sobrepõe o control plane e o data plane e pode causar instabilidade nas APIs, como perda de chamadas por timeout ou alta latência.
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]