API开放

开放API服务

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

API分组

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

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

域名及证书

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

二级域名是分组创建时系统分配的,唯一且不可更改。您可以通过访问二级域名来调用您测试中的API。二级域名仅用于测试,默认被限制为较小的流量。 独立域名是用于您开放API服务的,用户通过访问您的独立域名来调用您开放的API服务。您可以为一个分组绑定多个独立域名,上限为5个。对于独立域名的配置您需要注意以下几点:

a. 独立域名需要在阿里云备案系统备案成功才能使用。在别的系统备案的域名需要再接入阿里云备案系统才能使用。备案和接入流程。

b. 独立域名需要CNAME到该API分组的二级域名上,解析之后才能操作绑定到分组。先解析、后绑定。

c. 域名验证需要在一天内完成,一天之内未完成的绑定请求会被系统自动回收。

d. 如果要绑定的域名已经绑定在了其他的分组上,那么需要先更改域名解析,解析到即将要绑定的分组的二级域名上,然后再操作绑定,否则绑定不能成功。总之就是先解析、后绑定的原则。

当您的API支持HTTPS协议时,需要为该域名上传SSL证书,在“分组详情”页面进行添加即可。SSL证书上传不支持文件上传,需要填写证书名称、内容和私钥。

测试、线上、授权

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

当您完成API创建之后,您就可以将API发布到测试,并给自己创建的APP授权,通过访问二级域名来调用测试中的API进行测试。 成功绑定独立域名之后,您可以将API发布到线上,并给客户创建的APP授权,然后客户可以通过访问独立域名调用您的API服务。 既无论是您自己测试还是开放给客户使用,都需要授权的过程,被授权的APP才能调用相应的API。 至此,您已经能够开放您的API服务。在API创建到开放的整个过程中,您还可以随时操作API的创建、修改、删除、查看、测试、发布、下线、授权、解除授权、发布历史及版本切换等操作。

results matching ""

    No results matching ""