数据市场API产品接入-上架指南-阿里云开发者社区

开发者社区> 开发与运维> 正文
登录阅读全文

数据市场API产品接入-上架指南

简介: 数据市场是阿里云云市场的一个频道,支持API服务类商品的上架与售卖。为了方便第三方接入与购买,这里攒了这份API产品接入指引。

数据市场是阿里云云市场的一个频道,支持API服务类商品的上架与售卖。为了方便第三方接入与购买,这里攒了这份API产品接入指引。

什么是API服务类商品

API服务类商品就是服务商(卖家)在市场售卖的商品是以API形式调用的服务,如:气象信息API、图像识别API、语言翻译API等。买家一般是开发者,买家可以调用卖家的API,作为原材料,产出最终的软件或服务。

接入步骤

接入综述

在做具体接入工作之前,我们先了解一下接入的逻辑和流程。

首先是整体的概念逻辑。1个API服务商品,对应1个API网关的分组,1个API网关的分组背后是0到多个API(如果是0个,那卖的就是空服务了)。相当于卖家可以把一组API服务打包,作为一个API服务商品进行售卖

概念图

部分卖家会担心每个API性能优先,如果进行售卖后,被调用频率过高,性能无法保证。因此API网关提供了流控策略,能够帮助卖家进行限流,避免后台API被拖垮。

API服务商品接入涉及到两个系统,分别是API网关和云市场:

发布流程图

API网关是使用云市场API类服务前必须开通的系统,当API网关中创建完分组后,即可同步在云市场里对API服务进行上架编辑操作。

自有API接入API网关

前置条件

自有API接入API网关前,请确认:

  • 确认分组的规划:1个商品对应1个分组,因此要上架多少个商品就要创建多少个分组;
  • 申请独立域名;1个分组对应1个域名,因此要创建多少个分组,就要申请多少个域名,但是域名申请需要绑定CNAME,需要等分组创建完后再申请;
  • 可被访问到的API服务,及服务的API说明文档;
  • 流控策略(可选)。

创建API分组

  1. 进入API网关控制台,点击“分组管理”菜单;
  2. 建立分组的区域,当前可选择的有华北1(青岛)华东1(杭州)华北2(北京)华南1(深圳),请选择与提供API服务的服务器相同的Region,或相近的Region;
    创建分组-1
  3. 点击“创建分组”,进入分组创建对话框,填写合适的“分组名称”和“描述”;
    创建分组-2
  4. 分组创建完成之后,点击分组名称,进入分组详情页面,可以看到二级域名中有一个长长的一串域名,拿着这个长长的二级域名就可以去申请域名了(不一定要一级域名,二级、三级等域名都可以,但是这个域名是专用的)。在申请域名中,注意使用CNAME类型的解析,并且解析到那个长长的二级域名。一旦域名申请下来,就可以“绑定域名”,绑定域名时会自动检查CNAME设置是否正确(也就是配好域名的解析规则前是无法绑定的),视情况,可以添加SSL证书(注意公钥、私钥不要弄反)。
    申请域名

创建API

分组创建完毕后,也可以先创建API并绑定。创建API在“API列表”菜单里,选择合适的Region并“创建API”。注意,API的Region和分组的Region需要一致。
创建API-1
在填写API信息时,若安全认证填“无认证”,则任何人都可以无需事先购买和授权就进行调用。后端服务地址是真实的提供服务的地址。在填写这些信息时,相信后端的服务已经准备就绪,就是当前能调通的那个地址,最终用户不会感知到这个地址。
创建API-2
服务的Path是最终用户能感知到的地址,和真实的服务地址可以不一致。在“请求Body”一栏中经常容易把请求body中的字符串、JSON当成form表单去填,如果是字符串、JSON、二进制数据等,请选择“使用二进制数据”。
创建API-3
常量参数、系统参数,对最终调用者不可见,对服务提供者可以见。用常量参数、系统参数,服务提供者能够对API进行一些统计、鉴权等,更多用途可以慢慢挖掘。需要注意的是,在HTTP协议中,Header是不区分大小写的,Query中是有大小写区分的,这里需要服务提供方的程序员注意。Tips:在服务测试阶段,可以把所有系统参数都设上,然后看服务端打印的那些系统参数,从而选择在生产中是否要设置系统参数、设置哪些系统参数。
创建API-4
最后填写完“结果基础定义”,整个API定义到此结束。

测试API及上线

  1. API创建完毕后,需要进行测试和发布。测试发布后,即可对API进行测试。测试与是否绑定域名无必然联系,如果未绑定域名,可以用二级域名进行测试,如果绑定了域名,则可以用域名进行测试。访问测试环境的API,需要在Header中加入名为“X-Ca-Stage”的键,且值为“test”。
    调试API

调用时如果用“调试API”页面,请确保后端用的是HTTP;如果自己写程序,请参考这份文档;如果希望使用SDK,请从这里获取
调试API

  1. 如果测试没有问题,即可生产发布(生产发布前视情况配置流控策略)。

API服务商品上架

前置条件

API服务商品上架前,请确认:

  • 已经作为服务商入驻“数据市场”,并完成支付宝绑定、实名认证等一系列流程(帮助);
  • 确认已有数据服务商品的规划(当然,如果还没有的话,API接入API网关一步都无法正确进行);
  • 每个商品需要有对应的商品图片(160×120像素)、商品介绍、定价、最终用户协议(云市场可以给出一份范例,录入商品时可以看到),如果还没有,在填写前准备好就行。

发布商品

  1. 进入“服务商平台管理”,选择“商品管理”菜单,点击“发布商品”按钮。
    发布商品-1
  2. 选择“接入类型”,因为本篇文档阐述的是API服务的接入,因此这里就选择“API服务”。发布商品时分组看不到的话,请确认选择了正确的Region。
    发布商品-2
  3. 上传商品图片、商品介绍、商品详情。复杂的商品详情格式,请使用图片。
    发布商品-3
  4. 填写商品所属类目等信息。
    发布商品-4
  5. 填写商品销售信息。
    发布商品-5
  6. 填写商品协议等信息。在这之前,每点击“下一步”都是保存,可随时退出,这一页点击“提交”,在审核前无法修改,请谨慎点击提交按钮。
    发布商品-6
  7. 确认无误后,点击提交,等待审核通过,即上架成功。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

其他文章
最新文章
相关文章