Conexión con gateways AWS

Esta página describe cómo integrar sus soluciones de Sensedia (Adaptive Governance y Developer Portal) con gateways de AWS, lo que permite la importación y el gobierno de APIs (conexiones nativas) publicadas en Amazon API Gateway.

Vea en esta página:

Versiones compatibles de AWS API Gateway.
Cómo obtener credenciales de acceso.
Cómo crear una nueva conexión de gateway de AWS.
Importar APIs.

Versiones y Tipos de API Soportados

El Amazon API Gateway está estructurado en dos infraestructuras principales (v1 y v2). La importación de APIs mediante conexión nativa con AWS ofrece soporte para ambas.

REST API (v1). Versión tradicional de API Gateway, que proporciona el conjunto más completo de funcionalidades de gestión de APIs. Ver documentación oficial
HTTP API (v2). Infraestructura más reciente de Amazon API Gateway, optimizada para menor latencia y reducción de costos, enfocada en APIs HTTP de alto rendimiento e integraciones simplificadas con los servicios de AWS. Ver documentación oficial

Para un análisis detallado de las diferencias entre estas dos versiones, consulte: Diferencias entre REST APIs y HTTP APIs

La siguiente tabla resume las principales características de los tipos de API soportados:

Característica	REST API (v1)	HTTP API (v2)
Enfoque principal	Funcionalidades avanzadas de gestión de APIs	Alto rendimiento y menor costo
Soporte de Apps en el Portal	Sí	No (limitación del modelo HTTP API de AWS)
Importación mediante conexión nativa	Sí	Sí

Característica

REST API (v1)

HTTP API (v2)

Enfoque principal

Funcionalidades avanzadas de gestión de APIs

Alto rendimiento y menor costo

Soporte de Apps en el Portal

Sí

No (limitación del modelo HTTP API de AWS)

Importación mediante conexión nativa

Sí

La creación de la conexión nativa con AWS y la configuración de las credenciales es idéntica para ambas versiones. La distinción ocurre únicamente al momento de la importación de la API.
Actualmente, nuestras soluciones ofrecen soporte solo para APIs de los tipos REST (v1) y HTTP (v2). Las APIs del tipo WebSocket no son compatibles en este flujo de integración.

Credenciales de acceso

Para crear una connection for AWS API Gateway, debe ingresar sus credenciales de AWS en la pantalla de Connections.

Estas credenciales deben obtenerse desde el lado de AWS.

Acceda al AWS Management Console y siga los pasos a continuación para:

Crear un usuario.
Agregar una política de acceso.
Crear credenciales.

Consulte la documentación de AWS para obtener más detalles.

Para listar e importar sus APIs, asegúrese de que su política de acceso en AWS conceda permiso a los recursos correctos del servicio apigateway, según la versión del gateway:

Para gateways v1 (REST): la política debe permitir el acceso a los recursos bajo el espacio de nombres /restapis.
Para gateways v2 (HTTP): la política debe permitir el acceso a los recursos bajo el espacio de nombres /apis.

Si su política permite solo uno de estos conjuntos de recursos, se visualizarán únicamente las APIs correspondientes. En caso de que no haya permiso para ninguno de ellos, se mostrará un error en la pantalla de importación.

Creando un usuario

Existen varias formas de crear un usuario IAM en su cuenta AWS.

Con los pasos a continuación, creará un usuario a través del AWS Management Console:

En la parte superior del AWS Management Console, en la barra de búsqueda, busque y seleccione IAM.
En el menú lateral izquierdo, en Access management, seleccione Users.
Haga clic en el botón Create user en la esquina superior derecha de la pantalla.
En el campo User name, ingrese el valor: adaptive_governance_integration_aws y haga clic en Next.
En Permissions options, seleccione Attach policies directly y haga clic en Next.

En Permissions policies, NO seleccione Policy name.
En Review and Create, revise la información y haga clic en Create user.

Agregando una política de acceso

En la lista de usuarios, seleccione adaptive_governance_integration_aws
En la pestaña Permissions, en Permissions policies, haga clic en el botón Add Permissions y, a continuación, haga clic en Create inline policy.
En Policy editor, seleccione la pestaña JSON.

Copie y pegue el siguiente código en el editor.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "apigateway:GET"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

ou

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "apigateway:GET"
            ],
            "Resource": [
                "arn:aws:apigateway:*::/restapis",
                "arn:aws:apigateway:*::/restapis/*",
                "arn:aws:apigateway:*::/restapis/*/stages",
                "arn:aws:apigateway:*::/restapis/*/deployments",
                "arn:aws:apigateway:*::/restapis/*/deployments/*",

                "arn:aws:apigateway:*::/apis",
                "arn:aws:apigateway:*::/apis/*",

                "arn:aws:apigateway:*::/apikeys",
                "arn:aws:apigateway:*::/usageplans"
            ]
        }
    ]
}

Dependiendo de las necesidades de su negocio, existen algunos modelos de policy que podrán ser utilizados.

Haga clic en Next.
En el campo Policy name, ingrese el valor adaptive_governance-aws y haga clic en Create policy.

Creando las credenciales

En la lista de usuarios, seleccione adaptive_governance_integration_aws y haga clic en la pestaña Security credentials.
Desplácese hacia abajo y, en Access keys, haga clic en Create access key.
Seleccione la opción Application running on an AWS compute service.

Marque la casilla de confirmación en la parte inferior de la página.
Haga clic en Next.
Verá su access key y su secret access key.
Anote estas credenciales para utilizarlas en el registro de la conexión AWS en Adaptive Governance.
Haga clic en Done.

Creando una nueva conexión

Siga los pasos a continuación para crear una nueva conexión.

Acceda a la pantalla Connections, haciendo clic en el menú lateral izquierdo o en el card en la pantalla inicial.
Haga clic en el botón + CREATE CONNECTION, ubicado en la parte superior derecha de la pantalla.
Seleccione el proveedor de la conexión y haga clic en CREATE CONNECTION.
Seleccione el modo de conexión: si es nativa (datos actualizados directamente con el proveedor) o no (carga manual).

Conexión no nativa:

Defina un nombre para la conexión y haga clic en NEXT.
Confirme la información y haga clic en SAVE.

Conexión nativa:

Defina un nombre para la conexión y haga clic en NEXT.
Seleccione un modo de conexión: Access Key o IAM (Role ).
- Para Access Key:
  - AWS Access Key Id: informe la clave de su recurso AWS.
  - AWS Secret Access Key Id: informe el secreto de la clave de AWS.
  - Revise la información y haga clic en SAVE.
- Para IAM:
  - Configure your role: copie el código de ejemplo que se muestra en esta sección y utilícelo en su proveedor de AWS para crear un rol:
    
    Pasos en la Consola de AWS:
    
    Vaya a IAM > Roles y haga clic en el botón "Create role".
    
    Seleccione "Custom trust policy" y pegue el código copiado.
    
    Agregue la política generada en la etapa Agregando una política de acceso.
    
    Concluya la creación del rol, agregando la información necesaria, como tags.
    
    Después de crear el rol, copie el Role ARN generado por AWS.
  - Role ARN: pegue aquí el Role ARN generado.
  - Revise la información y haga clic en SAVE.

Importando APIs

La importación de APIs a partir de una conexión nativa con AWS admite múltiples tipos de API Gateway.

Los tipos de API compatibles son:

REST — APIs provenientes de AWS REST API Gateway (v1).
HTTP — APIs provenientes de AWS HTTP API Gateway (v2).

Vea más detalles sobre cada tipo.

Estos tipos se presentan en la columna Protocol Type durante el proceso de importación.

Para importar APIs, siga los pasos a continuación:

Ingrese a la pantalla Connections, haciendo clic en el menú lateral izquierdo o en la card de la pantalla de inicio.
Encuentre la conexión que desea editar y haga clic en el ícono .
Si es necesario, utilice la barra de búsqueda para localizar la conexión deseada.
En la pantalla API Imports, haga clic en el botón + IMPORT API, ubicado justo debajo de General Info y encima de API Imports.
Seleccione la región de las APIs que desea importar.
En la lista de APIs, utilice la columna Type para identificar el protocolo (REST o HTTP). Seleccione las APIs deseadas y haga clic en SAVE.

La generación de credenciales (creación de Apps) en o Developer Portal no es compatible actualmente para APIs del tipo HTTP (v2), debido a una limitación inherente a esta versión de AWS Gateway.

En estos casos, la opción Enable Apps registration permanece deshabilitada en la configuración de API Docs del Portal Manager.

La funcionalidad de Discovery también identifica y unifica APIs de ambas versiones (REST y HTTP) automáticamente, siempre que los permisos de acceso del usuario IAM cubran los recursos necesarios. Si cuenta con permiso para solo una de las versiones, únicamente se listarán las APIs correspondientes.

Siempre que una API sea actualizada, haga clic en ícono de recargar .
detalle con el botón para recargar APIs importadas

Thanks for your feedback!

EDIT

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