添加 API 密钥

为外部客户端分配 API 密钥后，外部客户端就可以访问管理系统中的数据并与之交互。在 REST API 调用中，将 API 密钥作为 apikey 查询参数或 apikey 请求标头进行交互。使用 API 密钥的 REST API 调用不会创建持久性服务器连接，并且 API 密钥必须包含在外部客户提交的所有 REST API 请求中。

开始之前

如果在添加 API 密钥时插入证书，请确保事先从证书颁发机构获取证书。

过程

在 " API 密钥 " 应用程序中，单击添加 API 密钥。
在 " 添加 API 密钥 " 对话框中，在用户字段中选择要为其创建 API 密钥的用户。
如果您想为API密钥指定过期日期，请将分钟数或过期日期设置为on。如果您想以分钟为单位指定有效期，请将此选项设置为关闭。
如果要为添加的 API 密钥插入证书，请将证书设为 true。
显示 " 插入证书 "字段。

在插入证书字段中，粘贴有效且唯一的证书。

证书格式必须以 -----BEGIN CERTIFCATE----- 开头，以

-----END
CERTFICATE-----

结尾。它必须符合 PEM X.509 标准。

下例是证书样本：

-----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-----

注：

如果不插入证书，则会创建一个普通的 API 密钥。
如果插入无效证书，系统会显示错误。
如果插入重复证书，系统将不予接受。
证书有自己的有效期。如果为 API 密钥设置了过期日期，则以较早的日期为准。

单击 " 创建 " 添加 API 密钥。
创建 API 密钥后，可以在 API 应用程序生成的卡片中查看有效期以及是否是基于证书的 API 密钥。

后续操作

如果在添加 API 密钥时插入证书，则必须将其添加到 Maximo® Application Suite 用户界面的受信任证书中。

从套件管理菜单，转到工作空间，然后选择 " 管理 " 磁贴。
点击 “操作” > “更新配置”。
在更新管理配置窗口中，单击导入证书行中的编辑图标。
点击添加，指定别名并粘贴证书内容。
单击确认。
单击 " 应用更改 "保存对配置的更改。

要 WebSphere® Application Server Liberty 接受证书，就必须设置路由。

使用管理员凭据登录 Red Hat® OpenShift® 网络控制台。
从侧边导航菜单中，点击管理 > CustomResourceDefinitions。
在 CustomResourceDefinitions 页面上，搜索 ManageWorkspace。
单击 manageworkspace ，然后单击 Instances 选项卡。
选择一个实例，然后单击 YAML 选项卡。
在 spec.settings.deployment 部分，添加 certPassthroughRoute: true。
单击保存。系统将自动触发路由协调，完成后您可前往“网络 > 路由 ”查看新路由。
注意：如果将 certPassthroughRoute 属性设置为 false ，则路由不会被删除。您必须手动删除路由。