数据市场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. 确认无误后,点击提交,等待审核通过,即上架成功。
目录
相关文章
|
1月前
|
API
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
|
1月前
|
数据采集 JSON Java
揭秘阿里巴巴:如何通过API实时捕获中国市场商品数据
阿里巴巴提供了丰富的API接口,使得第三方开发者可以实时捕获中国市场商品数据。以下是一些关键步骤和要点,帮助你揭秘如何通过阿里巴巴的API实现这一目标:
|
2月前
|
监控 数据挖掘 API
商品评价聚合:利用API从多个来源获取数据的详细指南
在当今电子商务的繁荣发展下,消费者在做出购买决策前越来越依赖商品评价。这些评价不仅反映了产品的实际使用体验,也直接影响着品牌信誉和销售业绩。为了全面了解消费者的声音并优化产品,企业需要从各种销售渠道收集和分析商品评价。本文将详细介绍如何通过API集成不同数据源的商品评价。
|
2月前
|
机器学习/深度学习 搜索推荐 API
商品信息全景图:API接口在聚合商品数据中的应用
在电子商务的世界中,API接口是连接不同服务和数据的桥梁。特别是在商品信息的聚合上,API接口扮演了至关重要的角色,它允许开发者从多个来源收集、整合并展示商品信息,从而为消费者提供全面且一致的购物体验。本文将深入探讨API接口在聚合商品数据中的应用,并通过具体的代码示例来揭示其工作原理。
|
2月前
|
小程序 API 开发者
【产品上新】接口不报错=API成功接入?不妨“验”一下
【产品上新】接口不报错=API成功接入?不妨“验”一下
29 0
|
2月前
|
数据采集 数据挖掘 API
主流电商平台数据采集API接口|【Python爬虫+数据分析】采集电商平台数据信息采集
随着电商平台的兴起,越来越多的人开始在网上购物。而对于电商平台来说,商品信息、价格、评论等数据是非常重要的。因此,抓取电商平台的商品信息、价格、评论等数据成为了一项非常有价值的工作。本文将介绍如何使用Python编写爬虫程序,抓取电商平台的商品信息、价格、评论等数据。 当然,如果是电商企业,跨境电商企业,ERP系统搭建,我们经常需要采集的平台多,数据量大,要求数据稳定供应,有并发需求,那就需要通过接入电商API数据采集接口,封装好的数据采集接口更方便稳定高效数据采集。
|
2月前
|
缓存 安全 API
【亿级数据专题】「高并发架构」盘点本年度探索对外服务的百万请求量的API网关设计实现
公司对外开放的OpenAPI-Server服务,作为核心内部系统与外部系统之间的重要通讯枢纽,每天处理数百万次的API调用、亿级别的消息推送以及TB/PB级别的数据同步。经过多年流量的持续增长,该服务体系依然稳固可靠,展现出强大的负载能力。
55 9
【亿级数据专题】「高并发架构」盘点本年度探索对外服务的百万请求量的API网关设计实现
|
1月前
|
JSON Java API
教你如何使用API接口获取数据
随着互联网技术的发展和应用的普及,越来越多的系统和应用提供API接口供其他系统和应用进行数据交互。通过API接口,我们可以获取到各种各样的数据,例如天气预报、股票行情、新闻摘要等等。本文将介绍如何使用API接口获取数据,并附有示例代码。
|
2天前
|
API
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态。
|
24天前
|
供应链 搜索推荐 BI
深入了解淘宝原数据:获取API接口及其使用场景
在当今数字化的时代,对于电商行业来说,数据具有极大的价值。淘宝作为中国最大的综合电商平台,拥有庞大的商品信息和用户数据。对于开发者和企业来说,淘宝原数据的获取和分析是实现个性化服务和精准营销的基础。本文将介绍如何通过API接口获取淘宝原数据,以及数据的使用场景。

热门文章

最新文章