App
En el contexto de las APIs, una app es una aplicación que consume las APIs disponibles. En nuestro caso, es una aplicación que consume las APIs registradas en su API Manager.
Generalmente, una app consume las APIs en nombre de un socio. Por ejemplo, un comerciante que necesita registrar productos en su marketplace o usar su solución de pago, una empresa asociada que necesita consultar datos de su backend, entre otros.
Las apps creadas en el Manager son una de las capas de seguridad de las APIs, ya que cada app está identificada por un Client ID y un Client secret ID. Además, las apps proporcionan visibilidad sobre quién está consumiendo sus APIs, ya que se identifican en los detalles de rastreo de las llamadas recibidas.
Contexto
Puede usar apps cuando desee que algún consumidor o canal específico consuma un grupo de APIs del ecosistema de su Sensedia API Platform.
Estructura del Archivo .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
Este formato de configuración le permite:
Consulte la documentación de Apps para más detalles. |
Listar Apps
-
Para listar todas las apps disponibles, utilice el comando:
ssd apim get app
-
Para encontrar una app específica, utilice el comando:
ssd apim get app --name "my-app"
-
Para encontrar una app por ID, utilice el comando:
ssd apim get app --id "123
Conectar APP a API
Puede conectar una App a una API utilizando el objeto ApiAppLink
.
Al hacerlo, debe haber creado:
-
Una API;
-
Un Plan;
-
Una App.
Consulte la documentación de ApiAppLink para ver cómo utilizarlo. |
Share your suggestions with us!
Click here and then [+ Submit idea]