API开放__使用手册（开放API）_API 网关-阿里云

API创建完成后，您就可以开放API服务了。要开放API服务您需要绑定一个在阿里云系统备案成功的独立域名，且该域名要完成CNAME解析。而独立域名是绑定在API分组上面的，所以在这个部分为您详细说明一下开放API服务需要了解的API分组和域名。

API分组

API分组是API的管理单元。您创建API之前，需要先创建分组，然后在某个分组下创建API。分组包含名称、描述、区域（Region）、域名几大属性。

分组的区域（Region）在分组创建时选定不可更改。创建API时，如果选定分组那么Region也一同选定，不可更改。
每个账号API分组个数上限为50个，每个分组API个数上限为200个。
域名。分组创建时，系统会为分组分配一个二级域名。如果需要开放API服务，您需要为分组绑定一个在阿里云系统备案成功的独立域名，且将独立域名CNAME到相应的二级域名上。每个分组最多只能绑定5个独立域名。具体请看下文——域名及证书。

环境管理

关于环境需要理解两个概念，环境和环境变量。

环境是API分组上的一个配置，每个分组有若干个环境。API录入后，未经发布时，就只是API定义。发布到某个环境后才是能够对外提供服务的API。

环境变量是在环境上用户可创建可管理的一种变量，该配置是固定于环境上的。如在线上环境创建变量，变量名为“Path”，变量值为“/stage/release”.

在API定义中的Path位置，协作“#Path#”，即配置为变量标识，变量名为Path。

那么将该API发布到线上环境时，该API在线上环境的运行定义，Path处的“#Path#”，会取值为“/stage/release”。

而将该API发布到其他环境时，若环境上没有环境变量#Path#，则无法取值，那么API就无法调用。

使用环境变量可以解决后端服务需要区分环境的问题，通过不同的环境上配置不同的服务地址和Path，来调用不同的后端服务，同时API的定义配置又是一套。使用时需要注意以下几点：

域名及证书

API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。如果要开放API服务，您需要了解二级域名和独立域名。

二级域名是分组创建时系统分配的，唯一且不可更改。在您还没有独立域名之前，您可以通过访问二级域名来测试调用您的API。二级域名仅能用于测试，默认每天只能请求1000次。
独立域名即自定义域名，是您开放API服务需要绑定的，用户通过访问您的独立域名来调用您开放的API服务。您可以为一个分组绑定多个独立域名，上限为5个。对于独立域名的配置您需要注意以下几点：

a. 独立域名不必须是根域名，可以是二级、三级域名

b. 独立域名如果尚未备案，则可以在阿里云做首次备案

c. 独立域名若已在其他系统备案，则需要在阿里云做备案接入

d. 独立域名需要CNAME解析到分组的二级域名上

e. 满足上述的备案和解析两个要求，域名才能成功绑定
当您的API服务支持HTTPS协议时，需要为该域名上传SSL证书，在“分组详情”页面进行添加即可。SSL证书上传不支持文件上传，需要填写证书名称、内容和私钥。

测试、线上、授权

通过上述操作您已经完成API的创建和域名绑定，接下来就可以将API发布到测试或者线上环境，进行调试和开放了。其中一个重要的环节是授权，授权即授予某个APP可以调用某个API的权限。

当您完成API创建之后，您就可以将API发布到测试或者线上，并给自己创建的APP授权，通过访问二级域名来调用指定环境中的API，进行测试。
成功绑定独立域名之后，您的API就可以正常投入使用或者开放了。您可以将API在市场上架，供客户购买、调用。您还可以不经过购买将API授权给合作伙伴的APP。您的API就能够被访问了。

至此，您完成API服务的开放。在API创建到开放的整个过程中，您还可以随时操作API的创建、修改、删除、查看、测试、发布、下线、授权、解除授权、发布历史及版本切换等操作。

最后更新：2016-11-24 11:23:48