ApiAppLink

With ApiAppLink you create an association of APIs for an app. This association grants defined permissions to a consumer’s Client ID. It includes a list of APIs, plans, and granted functions. It is possible to assign one or more APIs to an app with permission in one or more Sensedia API Platform access plans.

To trigger ApiAppLink, you need to have created:

  • An App;

  • An API;

  • A Plan.

List App

To list all available apps, use the command: ssd apim get app --name "app-sample"

Connect API to App

To connect an API to an App, you’ll need to grant permissions via ApiAppLink. Permissions can be for:

  • APIs

  • Plans

  • Apps

You can use an ApiAppLink to allow an app to access only the development environment.

Configure plan

apiVersion: api-management.sensedia.com/v1
kind: Plan
spec:
  # Identifying fields
  name: [DEV] Plan API Sample
  apiRef:
     name: API Sample
     version: 1.0.0
  description: Plan test
  default: true
  flows:
  - context:
      revision: 1
      resourceRef:
        name: customers
      operationRef:
        method: GET
        path: /customers
    requestInterceptors:
    - restrictAccess:
        environmentRefs:
        - name: Sandbox
        type: Allow

Connect API to APP, via plan

With the plan created in the previous topic, you can connect API and APP:

apiVersion: api-management.sensedia.com/v1
kind: ApiAppLink
metadata:
spec:
  # Identifying fields
  apiRef:
  - name: API Sample
    version: 1.0.0
    plans:
    - name: [DEV] Plan API Sample
  appRef:
     name: my-app
Thanks for your feedback!
EDIT

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