资讯中心

API是怎么开放的?——赛合一API知识讲堂

作为一个有态度的数据平台,【赛合一数据】从来都只做最适合企业的API接口。上次我们谈到了API是怎么创建的,现在跟着【赛合一数据】继续来看API是怎么开放的。

 

其实API 创建完成之后,你就可以开放API服务了。不过要开放API服务需要绑定一个在开发系统中备案成功的独立域名(比如说,你要开放的API用的是【赛合一数据】的开发系统,那么你就要绑定一个在【赛合一数据】开发系统中已经备案成功的独立域名),而且该域名要完成 CNAME 解析。另外,这个独立域名是绑定在API分组上面的,所以我们有必要了解一下开放API服务需要掌握的API分组和域名。

 

Part one   API分组

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

 

分组的区域(Region)在分组创建时选定不可更改。创建API时,如果选定分组那么 Region 也一同选定,不可更改。

每个账号API分组个数上限为50个,每个分组API个数上限为200个。

域名。分组创建时,系统会为分组分配一个二级域名。如果需要开放API服务,你需要为分组绑定一个在开发系统备案成功的独立域名,且将独立域名 CNAME 到相应的二级域名上。

Part two   环境管理

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

 

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

 

环境变量是在环境上用户可创建可管理的一种变量,该配置是固定于环境上的。如在线上环境创建变量,变量名为 Path,变量值为 /stage/release。在API定义中的 Path 位置,写作 #Path#,即配置为变量标识,变量名为 Path。那么将该API发布到线上环境时,该API在线上环境的运行定义,Path 处的 #Path#,会取值为 /stage/release。而将该API发布到其他环境时,若环境上没有环境变量 #Path#,则无法取值,那么API就无法调用。

 

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

1.API定义中配置了变量标识后,在API列表管理调试 页面将无法调试。

2.变量名严格区分大小写。

3.如果在API定义中设置了变量,那么一定要在要发布的环境上配置变量名变量值,否则变量无赋值,API将无法正常调用。

 

Part three   域名及证书

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

 

二级域名是分组创建时系统分配的,唯一且不可更改。在你还没有独立域名之前,你可以通过访问二级域名来测试调用你的API

 

独立域名即自定义域名,是你开放API服务需要绑定的,用户通过访问你的独立域名来调用你开放的API服务。不过,对于独立域名的配置你需要注意以下几点:

 

1.独立域名不必须是根域名,可以是二级、三级域名。

2.独立域名如果尚未备案,则可以在开发系统做首次备案

3.独立域名若已在其他系统备案,则需要在开发系统做备案接入

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

 

满足上述的备案和解析两个要求,域名才能成功绑定。

 

Part four   测试、线上、授权

完成以上全部操作之后,接下来就可以将API发布到测试或者线上环境,进行调试和开放了。其中一个重要的环节是授权,授权即授予某个应用可以调用某个API的权限。

 

当你完成API创建之后,你就可以将API发布到测试或线上,并给自己创建的应用授权,通过访问二级域名来调用指定环境中的 API,进行测试。成功绑定独立域名之后,你的API就可以在市场上架,供客户购买、调用。你还可以不经过购买将API授权给合作伙伴的应用,供其调用。

 

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