API 密钥 · Measure Map Online 帮助

创建连接你的网站或软件与 Measure Map Online 的密钥，选择它能做什么，将正式环境与测试工作分开，并安全地更换或限制密钥。

API 密钥让你自己的网站或软件可以使用你的 Measure Map Online 账户：在你的网站上显示项目的地图、为访客创建项目，或通过 REST API 读取和更改项目。你可以在开发者页面创建和管理密钥。

打开“开发者”页面#

在仪表盘菜单的高级下，按开发者。它默认打开 API 密钥，其他部分列在菜单中它的下方（在手机上显示为页面顶部的选项卡）：

访客链接（Open Guest）：为你的网站提供的免代码链接。参见 Open Guest。
试用 API、Webhooks 和 REST API：参见 API 参考。
嵌入地图（Enterprise）：参见 iFrame API。
私有项目（Enterprise）：在你的嵌入中显示客户的私有项目。参见客户的私有项目。

密钥卡片顶部的标记会说明你的密钥处于有效、未激活（尚无密钥）、已禁用（API 访问被暂停：在支持团队解除之前，任何密钥都无法使用，也无法创建新密钥）还是 已过期（订阅已失效）状态。

“API 密钥”部分：一个 Sandbox 密钥（除首尾外均被隐藏）、它的权限、显示和复制它的按钮，以及“生成新密钥”

正式环境与沙盒#

在密钥卡片顶部，可在正式和沙盒之间切换。两者各有自己的密钥，页面会显示你所选的那一个。这一选择同样适用于试用 API，并且在你切换各部分时保持不变。嵌入地图和访客链接始终使用你的正式密钥，因为你网站的访客只能打开正式项目：打开其中任何一个都会把页面切回正式。

正式是你的真实账户，页面默认打开的就是它。请在你的网站上使用正式密钥。
沙盒用于构建和测试集成。使用沙盒密钥创建的项目、文件夹和产品与你的真实数据分开存放：正式密钥看不到它们，沙盒密钥也看不到你的正式数据。使用沙盒密钥发出的请求不计入你的用量数据，用它创建的访客项目也永远不会计费。

新建沙盒密钥绝不会影响你的正式密钥，反之亦然。

选择密钥能做什么#

当你创建密钥时，对话框会在 新密钥的访问权限 下列出 API 的每个领域。请为每个领域选择新密钥可以触及的范围：

领域	选项	允许的操作
嵌入的地图（Enterprise）	无访问权限, 允许	让查看者登录到嵌入式地图。大多数集成只需要这一项。
访客项目（Open Guest）	无访问权限, 允许	使用你服务器上的令牌，为访客启动一个访客项目。大多数集成只需要这一项。
项目	无访问权限, 读取, 读取和更改	项目和文件夹，包括其测量数据、评论和导出。
用户（Enterprise）	无访问权限, 读取, 读取和更改	你组织中的用户及其邀请、席位和团队。
组织（Enterprise）	无访问权限, 读取, 读取和更改	你的组织的资料、政策、单点登录和活动日志，以及席位。
产品	无访问权限, 读取, 读取和更改	你的产品目录及其价格。
访客（Open Guest）	无访问权限, 读取, 读取和更改	你的访客链接、访客项目和报价请求，访客的联系方式，以及你的预算。
账户	无访问权限, 读取, 读取和更改	你的计划、席位、API 使用情况、个人资料和邮件设置；使用 Open Guest 时还包括你的支出和预算。
开发者	无访问权限, 读取, 读取和更改	你的 API 密钥和 Webhook。密钥从不超出其自身权限。
客户（合作伙伴）	无访问权限, 读取, 读取和更改	你的客户、你为其付费的套餐、他们的邀请和发票。

对话框只显示你的套餐包含的领域。将指针悬停在某个选项上，可以看到它具体授予什么权限。你的第一个密钥默认只有 嵌入的地图，这正是嵌入地图所需要的全部；用来替换另一个密钥的新密钥，则从那个密钥的权限开始。至少选择一个领域。

密钥能做什么在创建时就已确定。若要给密钥更多或更少的权限，请创建一个新密钥。

创建密钥#

在密钥卡片顶部选择正式或沙盒。
按生成新密钥。会打开一个对话框，标题旁边显示正式或沙盒。
在 新密钥的访问权限 下设置权限（参见上文）。
如有需要，在 新密钥的名称（可选） 中输入名称，以便区分你的各个密钥。
按创建。

随后对话框会显示你的新密钥已就绪。你随时可以在此页面再次复制它。它显示密钥（除首尾字符外均被隐藏），以及它 可执行的操作 的内容。按可完整显示，按可复制整个密钥，然后按完成。密钥卡片也会在 你的 API 密钥 下以同样方式显示它。你的账户每创建一个密钥，你都会收到一封电子邮件。

在引入权限设置之前创建的密钥#

在密钥有权限设置之前创建的密钥，可以做除处理产品之外的所有事情。这类密钥正在逐步停用：密钥卡片会说明你的密钥何时失效，你也会收到一条通知。请按生成新密钥（此时卡片会把它显示为主按钮），并在该日期之前替换你网站或服务器上的旧密钥。对话框默认只选 嵌入的地图，如果你的服务器需要更多权限，请自行勾选。

更换密钥#

已有密钥时，再次按生成新密钥，并在对话框中创建新密钥。对话框会说明当前密钥将发生什么：将创建一个新密钥，而你当前的密钥会继续有效 24 小时，以便你更新使用它的网站。完成后，你可以提前撤销它。在引入权限设置之前创建的密钥，则会一直有效到你被告知的那个日期。

旧密钥会移到 以前的密钥 下，并显示它的剩余时间、上次使用的时间以及它能做什么。在你逐步启用新密钥期间仍然有效。一旦没有任何地方在使用，请立即撤销。若要立即停用它，请按撤销并确认；仍在使用它的网站会立刻停止工作。密钥被吊销时，你会收到一封电子邮件。

你的网站限制会复制到新密钥。大约每分钟可以创建一个新密钥。

将密钥限制在你的网站#

只有此列表中的网站才能在浏览器中使用你的密钥：嵌入式地图以及来自其他任何网站页面的请求都会被拒绝。来自服务器的调用不受影响。

在 网站限制 下，在 输入网站或域名 中输入你的网站：可以是 example.com 这样的域名、IP 地址或 localhost。你可以粘贴完整地址：只会保留网站名称，不含 https://、路径和端口。
按添加。

一个域名同时涵盖它的子域名：example.com 允许 shop.example.com。按可移除某个网站，并确认；移除最后一个之后，该密钥可在任何网站上使用。每当从密钥中移除一个网站时，你都会收到一封电子邮件。

该列表适用于浏览器。嵌入的地图只会在列表中网站的页面上打开；当浏览器没有说明它所在的页面时，请求会被拒绝。从网页发出的 REST API 请求必须来自列表中的网站。来自你自己服务器的请求不会指明网站，因此不会被检查。Measure Map Online 本身始终被允许，所以此页面上的预览可继续正常工作。

查看密钥的使用情况#

用量会汇总你所有的正式密钥，所以更换密钥后数据仍会延续。它显示最近 30 天的请求（嵌入地图和 REST API 都包括），每天一根柱形；还显示 全部时间 的总数、最近访问、当前密钥的创建时间（密钥已创建），以及 热门域名：使用你的密钥最多的网站。如果在那里看到不认识的网站，就有理由限制或更换密钥。

沙盒请求不计入，因此这些数据只在正式下显示。此页面自身发出的请求（在试用 API 和预览中）也不计入。

保管好你的密钥#

只给每个密钥它所需的权限。放在网页中的密钥（例如在嵌入的地址里）应只具有 嵌入的地图。
此密钥可以更改你的数据。请将其保存在你的服务器上，切勿放在网页或应用中。
将用于网页的密钥限制在你自己的网站。
共享屏幕时，请让密钥保持隐藏状态；复制密钥从不需要把它显示出来。
如果密钥可能已泄露，请创建新密钥，并立即在 以前的密钥 下吊销旧密钥。
使用沙盒密钥来构建和测试，这样实验永远不会混入你的真实项目。