SuperMap iPortal密钥申请以及使用

目录

前言

一、功能介绍

1.1添加密钥（Key）

1.2使用密钥（Key）

1.3管理密钥（Key）

二、应用实例

作者：kxj

前言

    SuperMap iPortal 提供了一种密钥，简称：Key，它是在线开发中使用的应用密钥，是服务的口令标识。密钥（Key）配合 SuperMap iPortal 服务代理功能，可以保护用户在 iPortal 中注册和托管服务的安全，对于门户中受保护的服务，用户只有通过携带授权给该服务的 Key 才能调用该服务。Key 由24位随机字母+数字组成。

一、功能介绍

1.1添加密钥（Key）

iPortal 的普通用户和管理员都可以添加密钥。在门户首页，点击“登录”按钮，登录成功后，进入“我的账户”->“我的密钥”，选择“添加密钥”（首次添加密钥时，页面显示的是“获取key”，点击即可），进入添加密钥页面，输入相关参数并选择密钥允许访问的服务，点击“确定”按钮即可添加一个密钥：

• 应用名称：添加的密钥名称，建议与使用 Key 的应用名称一致，便于查找和管理。
• 应用类型：允许访问服务的客户端类型，包括：站点访问和服务请求。
  referer：对应的客户端类型是：站点访问。是指允许访问服务的站点地址，例如：http://www.supermapol.com
  访问源 IP：对应的客户端类型是：服务请求。是指访问服务客户端 IP，如果设置为 0.0.0.0，将允许所有 IP 访问（测试使用）
• 服务：选择该密钥允许访问哪些服务，列表中会列出当前用户自己注册和托管的非公开的服务（即我的服务）以及所有有权限访问的受保护的服务（不包含公开的服务），点击服务名称，选中该服务，再次点击服务名称，即可取消选中，支持多选。

点击“确定”按钮后，在我的密钥页面即添加一个密钥，“应用密钥（Key）”列显示的是密钥参数，也是用户使用的 Key。一个用户可以添加多个密钥，一个服务也可以对应（或绑定）多个密钥。

1.2使用密钥（Key）

生成的密钥（Key），主要用于在线应用开发过程中，访问受保护的服务时，无需提供用户名和密码，只需在其服务地址后加上密钥（Key）即可。例如：服务访问地址如下：

http://192.168.120.40:8195/iserver/services/map-HunanPopulationDensity/rest.rjson?key=v6ywlc7MJiAY6CQ0Ej4RXWD0 

其中，?前的部分是需要调用的服务地址，其后的部分（key=…）是访问需要的密钥请求参数，以此 url 发送请求即可进行访问。

iClient 调用 iPortal 中受保护的服务可以参考博客：iClient 调用 iPortal 中受保护的服务_iportal key-CSDN博客

1.3管理密钥（Key）

您可以管理自己添加的密钥（Key），在 iPortal 门户首页，点击“登录”按钮，登录成功后，进入“我的账户”->“我的密钥”，在开发授权页面会显示当前用户添加的所有密钥列表。

• 查看密钥：在密钥列表中，可以查看密钥的名称也即应用的名称、密钥请求参数、密钥的客户端类型、密钥允许访问的服务数量等。
• 删除密钥，支持勾选多个密钥进行批量删除，密钥一旦被删除，该密钥立即失效。
• 编辑密钥，包括修改应用名称、应用类型、允许访问的服务等。

二、应用实例

以China示例服务（https://iserver.supermap.io/iserver/services/map-china400/rest/maps/China）为例，设置仅admin用户（管理员）可访问，并通过key访问使用。

1. 使用admin用户（管理员）注册服务：
   【资源中心】-【服务】-【注册服务】，将China服务注册至iPortal，详细步骤可以参考帮助文档：http://support.supermap.com.cn/DataWarehouse/WebDocHelp/iPortal/iP/iportal_usage/add_resource/service.htm
   

2. 打开China服务的【共享设置】页面，关闭共享，此时仅admin用户（管理员）可访问改服务。
   

3. 申请密钥（key），具体设置如下：
   

4. 在浏览器端打开服务地址验证权限设置和key是否生效，验证结果如下：

• 直接打开代理服务地址报错401，结果正确：
  
• 携带密钥（key）打开代理服务地址正常，结果正确：
  
• 前端携带key进行服务加载正常，结果正确：