添加并注册应用程序

将 URL 引用添加到现有应用程序是一种与组织成员及普通公众共享工作成果的有效方法(根据共享权限)。 除 URL 之外,您还可共享其他详细信息,例如应用程序类型、用途、摘要和描述以及含有用于创建应用程序的代码的 .zip 文件。将应用程序添加至 ArcGIS Online 时,仅会添加对应用程序 URL 的引用;ArcGIS Online 不会存储应用程序文件。

作为拥有组织账户的应用程序开发者,您还可以在平台中注册应用程序。 这涉及注册 OAuth 应用程序,以便组织成员和组织外部的用户可以登录应用程序。有关详细信息,请参阅以下使用开发人员凭据添加和注册应用程序部分。

如果需要注册应用程序(例如当上传代码示例时),按照以下通过 URL 添加应用程序部分中的步骤执行操作。

提示:

另一种与组织成员及公众共享应用程序的方法是创建包含地图的应用程序包含群组的图库应用程序。

从 URL 添加应用程序

按照以下步骤添加使用 URL 访问 Web 上的应用程序但无需注册的项目(例如,代码示例):

注:

要添加已注册应用程序,按照相关步骤使用开发人员凭据添加和注册应用程序

  1. 验证您是否已登录,以及是否具备创建内容的权限
  2. 在内容页面的我的内容选项卡中,单击新建项目,然后单击应用程序
  3. 选择应用程序类型:
    • Web 制图 - 用 Web API 构建 Web 应用程序,如 JavaScript
    • 桌面 - 在桌面平台构建的用于桌面的应用程序,如 Java 或 .NET (Microsoft Windows Desktop)。
    • 移动 - 使用 SDK 为移动设备(如 iOSAndroid)构建的可下载应用程序。
    • 其他应用程序 - 桌面应用程序、Python 脚本或任何类型的通用应用程序,您没有关于应用程序用途、API、SDK 或 URL 地址的详细信息。
  4. 对于 web 制图、桌面或移动应用程序,请输入应用程序的 URL,例如 https://<myServer>/myWebMapApp
  5. 对于桌面应用程序,请单击浏览,然后选择包含应用程序的 .zip 文件。
  6. 单击下一步
  7. 输入标题。
  8. 我的内容中选择要用于保存项目的文件夹。
  9. 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。

    您还可以输入类别名称以缩小类别列表范围。

  10. 或者,输入用于描述项目的标签。

    多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。

    输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。

  11. 或者,添加描述应用程序的摘要。
  12. 单击保存

添加应用程序后,文件即会出现在您的内容中。 如果需要稍后注册,可以从应用程序项目页面的设置选项卡执行此操作。 有关详细信息,请参阅以下使用开发人员凭据添加和注册应用程序部分。

可以根据需要配置项目详细信息附加代码,如果您具有共享权限,则可以共享应用程序

使用开发人员凭据添加和注册应用程序

作为拥有组织账户的开发人员,可在平台中添加和注册您的应用程序以生成应用程序 ID。 在应用程序中使用应用程序 ID 来收集使用情况统计数据并允许用户使用 OAuth 2.0(一种标准授权框架)登录到平台。 应用程序可使用 OAuth 2.0 指导用户通过平台所托管的登录页面登录平台。 它也允许应用程序使用与组织相关联的用户内容和其他 ArcGIS Online 功能(例如地理编码、路径选择和 GeoEnrichment)。 要了解有关身份验证和 OAuth 2.0 的详细信息,请参阅 Esri 开发者

使用应用程序时可以添加的开发者凭据类型取决于您在组织中的权限。 如果您是默认管理员角色的成员,或是具有生成 API 密钥权限自定义角色成员,则可以在应用程序中使用 OAuth 2.0 或 API 密钥凭据。否则,仅可以在应用程序中使用 OAuth 2.0 开发者凭据。

注:

用户登录的实施模式会因您开发的是基于 Web 的应用程序还是原生应用程序而稍有不同。Esri 开发者 文档中包含同时适用于基于 Web 的应用程序和原生应用程序的详细信息与代码示例。

使用嵌入式 OAuth 2.0 凭据添加和注册应用程序

当您将 OAuth 2.0 凭据用于创建的应用程序时,将在应用程序被访问时动态生成访问令牌。 访问令牌的有效期最长为 14 天。

如果您的角色不具备创建 API 密钥的权限,请按照下方的步骤操作。

  1. 验证您是否已使用组织账户登录,以及是否具备创建内容的权限
  2. 单击内容页面的我的内容选项卡,然后单击新建项目
  3. 新建项目窗口中,单击开发人员凭据
  4. 为您显示的第一个窗口可能因您在组织中权限的不同而有所变化。 如果您的成员角色不具备创建 API 密钥的权限,请前进至步骤 5。 如果您的角色具备创建 API 密钥的权限,请前进至步骤 4。
  5. 选择 OAuth 2.0 凭据选项,然后单击下一步
  6. 重定向 URL 下,提供用于在用户成功登录后重定向用户的 Web 页面或服务器端点的 URL。 单击添加根据需要添加更多重定向 URL。

    授权期间指定的重定向 URL 必须与已注册 URL 之一相匹配,否则授权将遭拒。

    还可以指定特殊值 urn:ietf:wg:oauth:2.0:oob 以进行授权许可。 这会导致授权码传递到门户 URL (/oauth2/approval)。 此值通常用于没有可以提供代码的 Web 服务器或自定义 URL 方案的应用程序。

    下面是受支持的重定向 URL 格式的示例:

    • https://app.foo.com
    • urn:ietf:wg:oauth:2.0:oob

  7. Referrer URL 下,提供允许连接的 URL 或 IP 地址。 单击添加以根据需要添加更多 referrer URL 或 IP 地址。
  8. 应用环境下,选择应用程序的应用环境 - 多个原生浏览器服务器
  9. URL 框中,以 https://<myServer>/myWebMapApp 格式键入应用程序的 URL。
  10. 单击下一步

    如果您的成员角色有权限向 OAuth 2.0 应用程序分配权限,则单击下一步会使您转至一个窗口,您可在其中定义允许应用程序执行的操作。 如果您不具备此权限,请前进至步骤 12。

  11. 通过分配权限并单击下一步,可以选择凭据允许应用程序执行的操作。

    可供您选择的权限列表取决于您是否拥有 ArcGIS Location Platform 订阅,以及您在组织中拥有的权限。 您无法授予您的账户不具备的权限。

  12. 单击浏览项目,选择可以使用嵌入式凭据访问的项目,然后单击添加项目

    或者,可以单击跳过。 如果您跳过该步骤,不指定 OAuth 2.0 凭据用户可以访问的项目,则可以使用该凭据访问您拥有的所有项目。

  13. 输入标题。
  14. 我的内容中选择要用于保存项目的文件夹。
  15. 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。

    您还可以输入类别名称以缩小类别列表范围。

  16. 或者,输入用于描述项目的标签。

    多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。

    输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。

  17. 或者,添加描述应用程序的摘要。
  18. 单击下一步
  19. 查看凭据摘要。 要更改设置,可在创建项目之前单击返回执行更改。 如果凭据设置正确,请单击创建

应用程序即会添加至内容,其项目页面随即显示。 指示已将 OAuth 2.0 凭据用于应用程序的标记 OAuth 2.0 凭据 会显示在项目页面上,当用户从内容页面或项目预览窗格查看项目时,也会显示该标记。

您可以为应用程序配置项目详细信息

在应用程序项目页面的设置选项卡中,可以查看注册信息,其中包含应用程序 ID(客户端 ID)、应用程序密钥(客户端密钥)和应用环境。 可以更新数据源 URL 或重定向 URL、重置密钥、取消注册应用程序,或者复制或更新临时应用程序令牌。 也可以更改应用程序拥有的权限以及应用程序可以访问的图层。

注:

重置应用程序密码提示问题会使所有现有用户和针对此应用程序发布的应用程序令牌失效。用户必须再次登录此应用程序,通过密码提示问题配置的应用程序可能需要更新。

单击设置选项卡上的查看使用情况,以访问登录至应用程序的用户以及他们所用配额数的相关信息。

使用嵌入式 API 密钥凭据添加和注册应用程序

当您需要在应用程序中嵌入凭据时,请使用 API 密钥凭据,并且您需要密钥的有效期超过 14 天。

按照以下步骤添加应用程序,并创建一个嵌入其中的 API 密钥以用于身份验证。

  1. 验证您是否已使用组织账户登录,以及是否具备创建内容和创建 API 密钥的权限
  2. 单击内容页面的我的内容选项卡,然后单击新建项目
  3. 新建项目窗口中,单击开发人员凭据
  4. 选择 API 密钥凭据选项,然后单击下一步
  5. 使用日历指定凭据的有效期。

    凭据可以在次日(最小值)或 365 天(最大值)后过期。 它们将在所选到期日期的晚上 11:59 到期。 此时间的存储基于您添加应用程序和生成凭据时的浏览器时间。

  6. Referrer URL 下,提供允许连接到应用程序的 URL 或 IP 地址。根据需要单击添加以添加更多 referrer URL 或 IP 地址。

    授权期间指定的重定向 URL 必须与已注册 URL 之一相匹配,否则授权将遭拒。

  7. 单击下一步
  8. 通过分配权限并单击下一步,可以选择凭据允许应用程序执行的操作。

    可供您选择的权限列表取决于您是否拥有 ArcGIS Location Platform 订阅,以及您在组织中拥有的权限。 您无法授予您的账户不具备的权限。

  9. 单击浏览项目,选择可以使用嵌入式凭据访问的项目,然后单击添加项目

    或者,可以单击跳过。 如果您跳过该步骤,不指定 API 密钥用户可以访问的项目,则可以使用该凭据访问您拥有的所有项目。

  10. 输入标题。
  11. 我的内容中选择要用于保存项目的文件夹。
  12. 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。

    您还可以输入类别名称以缩小类别列表范围。

  13. 或者,输入用于描述项目的标签。

    多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。

    输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。

  14. 或者,添加描述应用程序的摘要。
  15. 单击下一步
  16. 查看凭据摘要。 要更改设置,可在创建项目之前单击返回执行更改。 如果凭据设置正确,请单击创建

应用程序即会添加至内容,其项目页面随即显示。 指示已将 API 密钥与应用程序一同嵌入的标记 API 密钥凭据 会显示在项目页面上,当用户从内容页面或项目预览窗格查看项目时,也会显示该标记。

您可以为应用程序配置项目详细信息

在应用程序项目页面的设置选项卡中,可以查看注册信息,其中包含应用程序 ID(客户端 ID)、应用程序密钥(客户端密钥)和应用环境。 可以更新重定向 URL、重置密钥、取消注册应用程序,或者复制或更新临时应用程序令牌。 也可以更改应用程序拥有的权限以及应用程序可以访问的图层。

注:

重置客户端密码提示问题会使所有现有用户和针对此应用程序发布的应用程序令牌失效。用户必须再次登录此应用程序,并且通过密码提示问题配置的应用程序可能需要更新。

单击设置选项卡上的查看使用情况,以访问登录至应用程序的用户以及他们所用配额数的相关信息。

相关主题