API服务操作指南

新建项目并添加API

新建项目

1. 点击“管理中心 > API服务 > API库 > 新建项目”，根据页面指引完成项目创建。项目创建完成后，可在“API库”页面刷新查看项目信息。

   

添加API

1. 点击“API库”，并在API库里面找到需要的API。
2. 点击API卡片，进入API详情页，并点击“启用”，签署协议后完成API的启用。

   

创建项目级凭证

使用 API前请先创建凭证。凭证有如下四种：服务账号密钥、OAuth 2.0 客户端ID、API密钥、应用级客户端ID，介绍如下：

1. 服务账号密钥：通过机机账号实现服务器到服务器应用级身份认证。
2. OAuth 2.0 客户端ID：通过用户第三方授权，让您的应用有权访问用户数据（项目级）。
3. API密钥：通过简单的API密钥来标识您的项目，访问公开级别的数据，以便检查权限和访问情况。
4. 应用级客户端ID：通过用户第三方授权，让您的应用有权访问用户数据（应用级）。该创建入口已经关闭，历史数据仍然可以使用。

服务账号密钥

1. 点击API卡片，进入API详情页，并点击“启用”，签署协议后完成API的启用。

   

2. 点击“凭证 > 项目级凭证 > 服务账号密钥 > 创建凭证”。

   

3. 点击“生成公私钥”，公钥上传，私钥自己保存。

   

4. 点击“创建并下载JSON”，完成“服务账号密钥”凭证创建。

   

   注： 如果不点击生成公私钥，则下载的json里面没有私钥信息。

   点击“管理服务账号”>“添加”，您可以增加公私钥数量。

   

   

   每个服务账号名称可增加最多100个公私钥。

   

OAuth客户端ID

API密钥

1. 点击API卡片，进入API详情页，并点击“启用”，签署协议后完成API的启用。

   

2. 点击“凭证 > 项目级凭证 > API密钥 > 创建凭证”。

   

3. 点击“限制密钥”可以对密钥设定相关限制，设定密钥限制可避免未经授权的使用行为或配额遭到窃用，也可不做限制。可以进行“应用限制”和“API限制”。

   应用限制：用于控制哪些网站、IP 地址或应用可以使用您的 API 密钥。可以为每个密钥设置一项应用限制。

   API限制：指定此密钥用于可调用的已启用的API。

   

创建开发者级凭证

创建开发者级凭证前无需新建项目，目前仅支持服务账号密钥，通过机机账号实现服务器到服务器身份认证。

服务账号密钥

1. 点击“管理中心 > API服务 > 凭证 > 开发者级凭证 > 服务账号密钥 > 创建凭证”。

   

2. 填写服务名称账号密钥名称。

   

3. 点击“生成公私钥”，公钥上传，私钥自己保存。

   

4. 点击“创建并下载JSON”，完成“服务账号密钥”凭证创建。

   

   注：如果不点击生成公私钥，则下载的json里面没有私钥信息。

5. 点击“管理服务账号 > 添加”，您可以增加公私钥数量。