将 URL 引用添加到现有应用程序是一种与组织成员及普通公众共享工作成果的有效方法(根据共享权限)。 除 URL 之外,您还可共享其他详细信息,例如应用程序类型、用途、摘要和描述以及含有用于创建应用程序的代码的 .zip 文件。将应用程序添加至 ArcGIS Online 时,仅会添加对应用程序 URL 的引用;ArcGIS Online 不会存储应用程序文件。
作为拥有组织帐户的应用程序开发者,您还可以在平台中注册应用程序。 这涉及注册 OAuth 应用程序,以便组织成员和组织外部的用户可以登录应用程序。有关详细信息,请参阅以下使用开发人员凭据添加和注册应用程序部分。
如果需要注册应用程序(例如当上传代码示例时),按照以下通过 URL 添加应用程序部分中的步骤执行操作。
从 URL 添加应用程序
按照以下步骤添加使用 URL 访问 Web 上的应用程序但无需注册的项目(例如,代码示例):
注:
要添加已注册应用程序,按照相关步骤使用开发人员凭据添加和注册应用程序。
- 验证您是否已登录,以及是否具备创建、更新和删除内容的权限。
- 在内容页面的我的内容选项卡中,单击新建项目,然后单击应用程序。
- 选择应用程序类型:
- Web 制图 - 用 Web API 构建 Web 应用程序,如 JavaScript。
- 桌面 - 在桌面平台构建的用于桌面的应用程序,如 Java 或 .NET (Microsoft Windows Desktop)。
- 移动 - 使用 SDK 为移动设备(如 iOS 或 Android)构建的可下载应用程序。
- 其他应用程序 - 桌面应用程序、Python 脚本或任何类型的通用应用程序,您没有关于应用程序用途、API、SDK 或 URL 地址的详细信息。
- 对于 web 制图、桌面或移动应用程序,请输入应用程序的 URL,例如 https://<myServer>/myWebMapApp。
- 对于桌面应用程序,请单击浏览,然后选择包含应用程序的 .zip 文件。
- 单击下一步。
- 提供标题。
- 在我的内容中选择要用于保存项目的文件夹。
您也可以从菜单中选择创建新文件夹,并输入文件夹名称,将项目保存在新文件夹中。
文件夹名称不能包含 4 字节 Unicode 字符。
- 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。
您还可以输入类别名称以缩小类别列表范围。
- 或者,输入用于描述项目的标签。
多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。
输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。
- 或者,添加描述应用程序的摘要。
- 单击保存。
添加应用程序后,文件即会出现在您的内容中。 如果需要稍后注册,可以从应用程序项目页面的设置选项卡执行此操作。 有关详细信息,请参阅以下使用开发人员凭据添加和注册应用程序部分。
使用开发人员凭据添加和注册应用程序
作为拥有组织帐户的开发人员,可在平台中添加和注册您的应用程序以生成应用程序 ID。 在应用程序中使用应用程序 ID 来收集使用情况统计数据并允许用户使用 OAuth 2.0(一种标准授权框架)登录到平台。 应用程序可使用 OAuth 2.0 指导用户通过平台所托管的登录页面登录平台。 它也允许应用程序使用与组织相关联的用户内容和其他 ArcGIS Online 功能,例如地理编码、路径选择和 GeoEnrichment。 要了解有关身份验证和 OAuth 2.0 的详细信息,请参阅 Esri 开发者。
或者,可在注册应用程序时在其中嵌入 API 密钥。
使用应用程序时可以添加的开发者凭据类型取决于您在组织中的权限。 如果您是默认管理员角色的成员,或是具有生成 API 密钥权限的自定义角色成员,则可以在应用程序中使用 OAuth 2.0 或 API 密钥凭据。否则,仅可以在应用程序中使用 OAuth 2.0 开发者凭据。
注:
用户登录的实施模式会因您开发的是基于 Web 的应用程序还是原生应用程序而稍有不同。Esri 开发者 文档中包含同时适用于基于 Web 的应用程序和原生应用程序的详细信息与代码示例。
使用嵌入式 OAuth 2.0 凭据添加和注册应用程序
当您将 OAuth 2.0 凭据用于创建的应用程序时,将在应用程序被访问时动态生成访问令牌。 访问令牌的有效期最长为 14 天。
如果您的角色不具备创建 API 密钥的权限,请按照下方的步骤操作。
- 验证您是否已使用具备创建、更新和删除内容权限的组织帐户进行登录。
- 单击内容页面的我的内容选项卡,然后单击新建项目。
- 在新建项目窗口中,单击开发人员凭据。
- 选择 OAuth 2.0 凭据选项,然后单击下一步。
- 在重定向 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
- 在 Referrer URL 下,提供允许连接的 URL 或 IP 地址。 单击添加以根据需要添加更多 referrer URL 或 IP 地址。
- 在应用环境下,选择应用程序的应用环境 - 多个、原生、浏览器或服务器。
- 在 URL 框中,以 https://<myServer>/myWebMapApp 格式键入应用程序的 URL。
- 单击下一步。
如果您的成员角色有权限向 OAuth 2.0 应用程序分配权限,则单击下一步会使您转至一个窗口,您可在其中定义允许应用程序执行的操作。 如果您不具备此权限,请前进至步骤 12。
- 通过分配权限并单击下一步,可以选择凭据允许应用程序执行的操作。
可供您选择的权限列表取决于您是否拥有 ArcGIS Location Platform 订阅,以及您在组织中拥有的权限。 您无法授予您的帐户不具备的权限。
有关权限类型的信息,请参阅 Esri 开发人员帮助中的安全和身份验证指南。
- 单击浏览项目,选择可以使用嵌入式凭据访问的项目,然后单击添加项目。
或者,可以单击跳过。
- 提供标题。
- 在我的内容中选择要用于保存项目的文件夹。
您也可以从菜单中选择创建新文件夹,并输入文件夹名称,将项目保存在新文件夹中。
文件夹名称不能包含 4 字节 Unicode 字符。
- 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。
您还可以输入类别名称以缩小类别列表范围。
- 或者,输入用于描述项目的标签。
多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。
输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。
- 或者,添加描述应用程序的摘要。
- 单击下一步。
- 查看凭据摘要。 要更改设置,在创建项目之前单击返回进行更改。
- 如果您已授予凭据的个人权限,请选中安全确认旁的复选框以确认您已阅读并同意该确认,然后单击创建以创建凭据。
应用程序即会添加至内容,其项目页面随即显示。 指示已将 OAuth 2.0 凭据用于应用程序的标记 会显示在项目页面上,当用户从内容页面或项目预览窗格查看项目时,也会显示该标记。 在项目页面的概览选项卡上,标记用于指示凭据中是包含个人权限,还是仅包含标准权限。
您可以为应用程序配置项目详细信息。
单击设置选项卡上的查看使用情况,以访问登录至应用程序的用户以及他们所用配额数的相关信息。
注:
在通过 ArcGIS Location Platform 订阅登录时,查看使用情况部分不可用。
您也可以管理应用程序中嵌入的凭据的设置。
使用嵌入式 API 密钥凭据添加和注册应用程序
当您需要在应用程序中嵌入凭据时,请使用 API 密钥凭据,并且您需要密钥的有效期超过 14 天。
按照以下步骤添加应用程序,并创建一个嵌入其中的 API 密钥以用于身份验证。
- 验证您是否已使用组织帐户进行登录,以及是否拥有创建 API 密钥内容以及创建、更新和删除内容的权限。
- 单击内容页面的我的内容选项卡,然后单击新建项目。
- 在新建项目窗口中,单击开发人员凭据。
- 选择 API 密钥凭据选项,然后单击下一步。
- 使用日历指定凭据的有效期。
凭据可以在次日(最小值)或 365 天(最大值)后过期。 它们将在所选到期日期的晚上 11:59 到期。 此时间的存储基于您添加应用程序和生成凭据时的浏览器时间。
- 在 Referrer URL 下,提供允许连接到应用程序的 URL 或 IP 地址。根据需要单击添加以添加更多 referrer URL 或 IP 地址。
授权期间指定的 URL 必须与已注册 URL 之一相匹配,否则授权将遭拒。
下面是受支持的 Referrer URL 格式的示例:
- https://www.example.com/pages
- https://www.example.com/pages/index.html
- 单击下一步。
- 通过分配权限并单击下一步,可以选择凭据允许应用程序执行的操作。
可供您选择的权限列表取决于您是否拥有 ArcGIS Location Platform 订阅,以及您在组织中拥有的权限。 您无法授予您的帐户不具备的权限。
有关权限类型的信息,请参阅 Esri 开发人员帮助中的安全和身份验证指南。
- 单击浏览项目,选择可以使用嵌入式凭据访问的项目,然后单击添加项目。
或者,可以单击跳过。
- 提供标题。
- 在我的内容中选择要用于保存项目的文件夹。
您也可以从菜单中选择创建新文件夹,并输入文件夹名称,将项目保存在新文件夹中。
文件夹名称不能包含 4 字节 Unicode 字符。
- 如果您的组织已设置内容类别,请单击分配类别并最多选择 20 个类别以方便其他用户查找项目。
您还可以输入类别名称以缩小类别列表范围。
- 或者,输入用于描述项目的标签。
多个术语之间使用逗号进行分隔(例如,Federal land 将被视为一个标签;Federal, land 则被视为两个标签)。
输入过程中,您可以选择显示的任何建议标签;建议由您之前添加的标签生成。
- 或者,添加描述应用程序的摘要。
- 单击下一步。
- 查看凭据摘要。 要更改设置,在创建项目之前单击返回进行更改。
- 如果您已授予凭据的个人权限,请选中安全确认旁的复选框以确认您已阅读并同意该确认,然后单击下一步。
- 选择是立即生成还是稍后生成 API 密钥,然后单击下一步。
生成 API 密钥后,必须立即复制该密钥。
- 如果单击生成 API 密钥并转至项目详细信息页面。 我准备复制并保存密钥。选项,则当单击下一步时,生成 API 密钥弹出窗口随即出现。 单击复制按钮以复制该密钥。 将该密钥粘贴到安全文档中。 完成后,请关闭弹出窗口。
- 如果单击转至项目详细信息页面。 我将稍后生成 API 密钥。选项,则凭据项目页面随即出现。 当单击下一步时,项目页面随即出现。 可以从项目页面的设置选项卡中生成 API 密钥。
应用程序即会添加至内容,其项目页面随即显示。 指示已将 API 密钥与应用程序一同嵌入的标记 会显示在项目页面上,当用户从内容页面或项目预览窗格查看项目时,也会显示该标记。 在项目页面的概览选项卡上,标记用于指示凭据中是包含个人权限,还是仅包含标准权限。
您可以为应用程序配置项目详细信息。
单击设置选项卡上的查看使用情况,以访问登录至应用程序的用户以及他们所用配额数的相关信息。
注:
在通过 ArcGIS Location Platform 订阅登录时,查看使用情况部分不可用。
您也可以管理应用程序中嵌入的凭据的设置。