App

In the context of APIs, an app is an application that consumes the available APIs. In our case, it is an application that consumes the APIs registered in your API Manager.

Usually, an app consumes APIs on behalf of a partner. For example, a shop owner who needs to register products in their marketplace or use their payment solution, a partner company that needs to query data from their backend, among others.

The apps created in Manager are one of the security layers, as each app is identified by a client ID and a client secret ID. Additionally, apps provide visibility into who is consuming your APIs since they are identified in the trace of incoming calls.

Context

You can use apps when you want a specific consumer or channel to consume a group of APIs from your Sensedia API Platform ecosystem.

App .yaml File Structure (apply command)

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

This configuration format allows you to:

  • Create an app;

  • Associate an API with an app;

  • Associate a plan for the API.

Access the Apps documentation for more details.

List Apps

  • To list all available apps, use the command: ssd apim get app

  • To find a specific app, use the command: ssd apim get app --name "my-app"

  • To find an environment by ID, use the command: ssd apim get app --id "123

Connect APP to API

You can connect an App to an API using the ApiAppLink object. When triggering it, you’ll need to have created:

  • An API;

  • A Plan;

  • An App.

Refer to the ApiAppLink documentation and see how to use it.
Thanks for your feedback!
EDIT

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