App

No contexto das APIs, uma app é uma aplicação que consome as APIs disponíveis. No nosso caso, é uma aplicação que consome as APIs registradas no seu API Manager.

Geralmente, uma app consome as APIs em nome de um parceiro. Por exemplo, um lojista que precisa cadastrar produtos em seu marketplace ou usar sua solução de pagamento, uma empresa parceira que precisa consultar dados do seu backend, entre outros.

As apps criadas no Manager são uma das camadas de segurança das APIs, pois cada app é identificada por um Client ID e um Client secret ID. Além disso, as apps dão visibilidade de quem está consumindo suas APIs, já que são identificadas nos detalhes de rastreamento das chamadas recebidas.

Contexto

Você pode usar apps quando quiser que algum consumidor ou canal específico consuma um grupo de APIs do ecossistema da sua Sensedia API Platform.

Estrutura do Arquivo .yaml de App (comando apply)

apiVersion: api-management.sensedia.com/v1
kind: App
spec:
  name: my-app
  clientId: //optional
  secret: //optional
  description: App Sample for johnson@sensedia.com
  developer: johnson@sensedia.com
  status: APPROVED | PENDING | REJECTED | CANCELLED
  link: ""
  showAppGallery: true | false
  ownerType: DEVELOPER
  apis:
  - name: API Sample
    version: 1.0.0
    description: Test API Sample
    plans:
    - name: [DEV] Plan API Sample
      description: Plan test
      defaultPlan: true | false
  extraInfo:
  - key: foo
    value: bar

Esse formato de configuração permite que você:

  • Crie uma app;

  • Associe uma API a uma app;

  • Associe um plano para a API.

Acesse a documentação de Apps para mais detalhes.

Listar Apps

  • Para listar todas as apps disponíveis, use o comando: ssd apim get app

  • Para encontrar uma app específica, use o comando: ssd apim get app --name "my-app"

  • Para encontrar um environment por ID, use o comando: ssd apim get app --id "123

Conectar APP a API

Você pode conectar uma App a uma API utilizando o objeto ApiAppLink. Ao acioná-lo, você precisará ter criado:

  • Uma API;

  • Um Plano;

  • Uma App.

Acesse a documentação de ApiAppLink e veja como usar.
Thanks for your feedback!
EDIT

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