Adición de claves de API

Cuando se asigna una clave API al cliente externo, éste puede acceder a los datos del sistema Manage e interactuar con ellos. La interacción se produce utilizando la clave API como parámetro de consulta apikey o como cabecera de solicitud apikey en las llamadas a la API REST. Las llamadas de API REST que utilizan una clave de API no crean una conexión de servidor persistente y la clave de API debe formar parte de todas las solicitudes de API REST realizadas por el cliente externo.

Antes de empezar

Si inserta un certificado al añadir una Clave API, asegúrese de adquirirlo previamente de una autoridad de certificación.

Procedimiento

  1. En la aplicación Claves de API , pulse Añadir clave de API.
  2. En el diálogo Añadir clave de API , seleccione el usuario para el que está creando la clave de API, en el campo Usuario .
  3. Establezca Minutos o Fecha de caducidad en activado si desea especificar una fecha de caducidad para la clave API. Desactívelo si desea especificar el período de caducidad en minutos.
  4. Establezca Certificado en true si desea insertar un certificado para la clave API que se está añadiendo.
    Aparece el campo Insertar certificado.
  5. En el campo Insertar certificado, pegue un certificado válido y único.
    El certificado debe tener un formato que empiece por -----BEGIN CERTIFCATE----- y termine por -----END CERTFICATE-----. Debe ajustarse a la norma PEM X.509.
    El siguiente ejemplo es un certificado de muestra:
    -----BEGIN CERTIFICATE-----
    MIIEAzCCAuugAwIBAgIQQoHZvObaTzAOe7m+/xDF8DANBgkqhkiG9w0BAQsFADCB
    hjELMAkGA1UEBhMCR0IxDzANBgNVBAcTBkxvbmRvbjEPMA0GA1UECRMGTG9uZG9u
    MS4wLAYDVQQLEyVJQk0gTWF4aW1vIEFwcGxpY2F0aW9uIFN1aXRlIChQdWJsaWMp
    MSU.............................................................
    EAxMxbWFuYWdlLmZyYW1l...........................................
    MDQyNC5hcHBzLm1hbmFnZS1vY3AyLmNwLmZ5cmUuaWJtLmNvbTCCASIwDQYJKoZI
    hvcNAQEBBQADggEPADCCAQoCggEBAPs7owfsm9eZV5z3XQSFCLY3DgnIubJwksrj
    BFs+t57O/Ly9w5vZki4VnKkpZ7ZWcICKdGHRO8bFK8UdufDDhgd21YczlQbOlfHh
    YemAL2wZUNo8kDp1XyBJn8z53F/cI+Ag1oxYBHhhFzgl4tInQ0IQlhU/nCSPQQ2k
    72DIiFz/K593BqMTOv35nVNZJWd2YvkLqJrNYtTnRpf1/o6gLs/qOzKwmDvwiQhv
    uhDwIfSn3kVk/EvcSXndlBuRWIuhjMc3uhB3dPnOLwR8VSoy5JhPyGbPIcpupODH
    TmYqJjrNqoPgSVBLlTcfxMZOVTGZZzC9PV8Qv55ADNb045ehE6MCAwEAAaOBtTCB
    sjAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBQJ5HnO
    ................................ajBogjFtYW5hZ2UuZnJhbWUwNDI0LmFw
    cHMubWFuYWdlLW9jcDIuY3AuZnlyZS5pYm0uY29tgjMqLm1hbmFnZS5mcmFtZTA0
    MjQuYXBwcy5tYW5hZ2Utb2NwMi5jcC5meXJlLmlibS5jb20wDQYJKoZIhvcNAQEL
    BQADggEBACFOl5PI2VTDkI8uUmB1ZnUZkTTdsXjpAc9QZTCpwgS42drq9PFdJRir
    5cUQBsRsfnXTTywKor01NkMf5rrgZwomqwDXl6fGJyODGEdbICN1x8VNGuAEkmxK
    fmly/MMKQRyl7xbFOvCITxNNNwL+VpLovtTOi46aK82qg5dBHRy7sBmwT3mKmnvz
    ................................................................
    /hwjphuBId3imKjz6dZculYspxg39NmHhDTsMUqugNSoROJkZ1vGkdRK9kQSchaE
    7ckHUx1cFCG/86................=
    -----END CERTIFICATE-----
    Nota:
    • Si no inserta un certificado, se crea una clave API normal.
    • Si inserta un certificado no válido, el sistema responde con un error.
    • Si inserta un certificado duplicado, el sistema no lo acepta.
    • Los certificados tienen su propia fecha de caducidad. Si establece una fecha de caducidad para la clave API, se aplicará la fecha que sea anterior.
  6. Haga clic en Crear para añadir la clave API.
    Puede ver la fecha de caducidad y si se trata de una clave API basada en certificado después de crear la clave API, en la tarjeta resultante de la aplicación API.

Qué hacer a continuación

Si inserta un certificado al añadir una clave API, debe añadirlo a los certificados de confianza en la Maximo® Application Suite interfaz de usuario.
  1. En el menú de administración de Suite, vaya a Espacios de trabajo y seleccione el mosaico Gestionar.
  2. Haga clic en Acciones > Actualizar configuración.
  3. En la ventana de configuración de Update Manage, haga clic en el icono Editar de la fila Certificados importados.
  4. Haga clic en Añadir para especificar un nombre de alias y pegar el contenido del certificado.
  5. Pulse Confirmar.
  6. Haga clic en Aplicar cambios para guardar los cambios en la configuración.
Para que WebSphere® Application Server Liberty acepte el certificado, debe configurar una ruta.
  1. Inicie sesión en la consola web Red Hat® OpenShift® utilizando sus credenciales de administrador.
  2. En el menú de navegación lateral, haz clic en Administración > CustomResourceDefinitions.
  3. En la página CustomResourceDefinitions busque ManageWorkspace.
  4. Haga clic en manageworkspace y, a continuación, en la pestaña Instances.
  5. Seleccione una instancia y haga clic en la pestaña YAML.
  6. En la sección spec.settings.deployment , añada certPassthroughRoute: true.
  7. Pulse Guardar. Se inicia automáticamente una reconciliación y, una vez completada, puede ver la nueva ruta en Redes > Rutas.
    Nota: Si establece la propiedad certPassthroughRoute en false, la ruta no se elimina. Debe eliminar manualmente la ruta.