API接口 返回值说明

已于 2022-12-23 15:08:05 修改
阅读量1k 收藏 1
点赞数
分类专栏： 电商API 文章标签： 电商API接口
于 2022-12-23 15:00:56 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Api_k/article/details/128419770
版权
本文介绍了API，特别是电商API的应用，它提供了一组定义、程序和协议，用于不同计算机软件之间的相互通信。API包括四种类型：RPC、SQL、文件传输和信息交付。举例说明了电商API的请求地址、请求参数如num_iid和is_promotion，以及如何通过不同的编程语言（如Curl、PHP、PHPsdk、JAVA、C#、Python）进行请求示例，并给出了响应示例。
摘要由CSDN通过智能技术生成

​介绍API：应用程序接口（API：Application Program Interface）

应用程序接口是一组定义、程序及协议的集合，通过 API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用 API 函数对应用程序进行开发，可以减轻编程任务。 API 同时也是一种中间件，为各种不同平台提供数据共享。

根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：

远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。

标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。

文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。

​公共参数

请求地址: https://console.open.onebound.cn/console/?i=Anzexi

名称 类型 必须 描述
key String 是 调用key（必须以GET方式拼接在URL中）
secret String 是 调用密钥
api_name String 是 API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]
cache String 否 [yes,no]默认yes，将调用缓存的数据，速度比较快
result_type String 否 [json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读
lang String 否 [cn,en,ru]翻译语言，默认cn简体中文
version String 否 API版本

请求参数

请求参数：num_iid=520813250866&is_promotion=1

参数说明：num_iid:淘宝商品ID
is_promotion:是否获取取促销价

响应参数

Version: Date:2022-04-04

名称 类型 必须 示例值 描述

item

 item[] 1 宝贝详情数据

num_iid

 Bigint 1 520813250866 宝贝ID

title

 String 1 三刃木折叠刀过安检创意迷你钥匙扣钥匙刀军刀随身多功能小刀包邮 宝贝标题

desc_short

 String 0 商品简介

promotion_price

 Int 0 优惠价

price

 Float 1 25.8 价格

total_price

 Float 0 0

suggestive_price

 Float 0 0

orginal_price

 String 0 25.80 原价

nick

 String 0 欢乐购客栈 掌柜昵称

num

 Int 0 3836 库存

min_num

 Int 0 0 最小购买数

detail_url

 String 0 http://item.taobao.com/item.htm?id=520813250866 宝贝链接

pic_url

 String 1 //gd2.alicdn.com/imgextra/i4/2596264565/TB2p30elFXXXXXQXpXXXXXXXXXX_!!2596264565.jpg 宝贝图片

brand

 String 0 三刃木 品牌名称

brandId

 Int 0 8879363 品牌ID

rootCatId

 Int 0 50013886 顶级分类ID

cid

 Int 1 50014822

crumbs

 Mix 0 [] 导航菜单

created_time

 String 0

modified_time

 String 0

delist_time

 String 0

desc

 String 0 商品详情

desc_img

 Mix 0 [] 商品详情图片

item_imgs

 Mix 0 item_imgs[] 商品图片

item_weight

 String 0

item_size

 String 0

location

 String 0 发货地

express_fee

 Float 0 0.00 快递费用

ems_fee

 Float 0 EMS费用

post_fee

 Float 0 物流费用

shipping_to

 String 0 发货至

has_discount

 Boolean 0 false 是否有优惠

video

 video[] 0 商品视频

is_virtual

 String 0

sample_id

 String 0 商品风格标识ID

is_promotion

 Boolean 0 false 是否促销

props_name

 String 0 1627207:1347647754:颜色分类:长方形带开瓶器+送工具刀卡+链子;1627207:1347647753:颜色分类:椭圆形带开瓶器+送工具刀卡+链子; 商品属性名。格式为pid1:vid1:name1:value1;pid1:vid2:name2:value2。

prop_imgs

 prop_imgs[] 0 商品属性图片列表
最低0.47元/天 解锁文章
技术小泽API
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【WebApi】WebApi 接口返回值不困惑：返回值类型详解
德仔
04-23 156
以上几种返回值类型能解决我们大部分返回值的问题，当然，你也可以将webapi的接口和普通方法一样，返回任意的类型，WebApi会自动序列化你自定义任何返回类型，然后将序列化的值写到响应正文里，状态码统一返回200。[HttpGet]//实际项目中，通过后台取到集合赋值给lstRes变量。这里只是测试。得到结果和上面的Json、Ok等用法在效果上面没有太大区别。以上通过四个方面详细分享了下WebApi里面返回值的常见用法，不能说哪种方式最好，因为每种方式都有其特定的使用场景。
API操作元素属性
jl_3288的博客
02-04 135
盒子
统一封装api接口返回值（二）
异世者的博客
05-29 945
在第一篇中，我们对接口返回值做了统一封装，轻松返回结果。 @GetMapping("/fail_response") public Result fail_response() { return Result.fail("失败了"); } @GetMapping("/success_response") public Result success_response() { return Result.success("ok");
Spring Cloud 架构设计之API接口返回值
yjjhk的专栏
05-20 744
本文定义了微服务中的公共返回值及分页对象返回值
银联接口返回值说明
weixin_30410119的博客
03-09 601
netpayclient.jar 为用于java和jsp开发的jar包，适用于各个操作系统。jdk版本为1.4。 客户端签名和验签方法说明public String signOrder(String MerId, String OrdId, String TransAmt, String CuryId, String TransDate, String TransType...
java~api返回值的标准化
weixin_33814685的博客
03-08 348
api返回值的标准化 例如 {"status":200,"message":"操作成功","data":"{\"id\":1,\"name\":\"张三\"}"} 封装返回对象 对象被封装在base.util.ResponseUtils类型下，返回值是标准的ResponseEntity对象，返回体 进行了二次封装，主要有status,messsage和data组成，返回方法有ok和okMessag...
接口测试返回码说明
tanying1028的专栏
11-14 5169
接口测试返回code值的含义 参考博客地址： https://www.cnblogs.com/yechangzhong-826217795/p/8522611.html 1xx - 信息提示 · 100 - Continue 初始的请求已经接受，客户应当继续发送请求的其余部分。（HTTP 1.1新） · 101 - Switching Protocols 服务器将遵从客户的请求转换到另外一种协...
WebApi接口返回值不困惑：返回值类型详解 - 文章 - 伯乐在线1
08-04
在Web API开发中，接口的返回值类型是一个关键部分，因为它直接影响着客户端如何接收和解析服务端的数据。本文主要探讨了Web API中的四种主要返回值类型：void、IHttpActionResult、HttpResponseMessage以及自定义...
K3 Cloud WebAPI接口说明书_2.0.docx
05-24
【K3 Cloud WebAPI接口说明书_2.0.docx】文档是金蝶云提供的一个关于如何使用WebAPI接口进行系统集成的详细指南。这个接口说明书适用于开发者和IT专业人士，他们需要利用这些接口来构建和扩展基于金蝶云的应用程序。...
航班管家OPEN-API接口说明
11-01
【航班管家OPEN-API接口说明】 在现代信息技术的快速发展下，开放API（Application Programming Interface）已经成为企业间合作与数据共享的重要手段。"航班管家"作为一款知名的出行服务应用，提供了OPEN-API接口，...
API 接口返回值
weixin_30467087的博客
07-12 637
API 接口返回值 https://blog.csdn.net/baple/article/details/52925772 转载于:https://www.cnblogs.com/chenliuxiao/p/9297989.html
Java如何调用接口API并返回数据（两种方法）
weixin_45817985的博客
08-23 2594
Java如何调用接口API并返回数据（两种方法）
接口返回数据内容
weixin_30872867的博客
08-22 3193
接口测试一般会返回这几个数据： {‘status’:200,'msg':'成功','datas':''} status：业务状态码，有时也是code msg：消息，请求成功还是失败等 datas：响应数据，响应数据类型为字典，也可以说是json格式的字符串 接口测试当中对响应数据所要做的重点就是断言 python当中，接口返回的数据中，null需要改成None，true需要改...
API接口返回参数设计的最佳实践
weixin_45710229的博客
08-06 2085
一、背景 ​ 在前后端还没有分离前，通常程序员是又当爹又当娘，不管是前端还是后端都是一个人开发。所谓的接口规范也是百花齐放，各有各的一套。现在流行前后端分离的项目中，一套较好的后端接口规范能够提高团队开发的效率。 ​ 因此，本文主要针对接口返回参数，结合已有项目中总结出来的一套比较完善的规范。 ​ 二、接口返回参数介绍 ​ 接口包含三大要素：状态码，结果集、成功或错误的提示。 { "code":"状态码", "data":"结果集", "massage":"成功或错误的提示" }
处理api返回的数据_Python API教程：API入门（上）
weixin_39613824的博客
12-30 1952
导读：我在这篇文章中向大家讲解一个简单的API，包括检索有关国际空间站的数据。什么是API？一个API，或被称为应用程序接口，是一个服务器为你提供一个接收或发送数据的代码。API通常用来接收数据。本文就集中焦点在此话题中。当我们想从一个API中接收数据，我们需要开始请求。请求可以包含整个Web。例如，你可以浏览博客文章。你的浏览器开始请求我们的Web服务器，会返回整个网页内容。API请求...
API快速开发平台设计思考
承接各种网站建设开发定制
01-08 452
一、类的设计 1.对象是通过类创建出来的，类的作用是用来描述一群具有相同的特征和行为的事物。 2.设计类三要素 类的名字：你要描述的这类事物叫什么名字； 这类事物具有的相同的特征：这类事物拥有什么； 这类事物具有的共同的行为：这类事物会做什么； 3.定义类的语法 [修饰符] class 类名{ 0或多个构造方法 //类创建对象的根本途径 0或多个变量 //类的属性 0或多个方法 //类的行为} 4.修饰符：对于类和类定义中的成员（如构造方法、变量、方法
分类详情 API 返回值说明
weixin_44353800的博客
01-10 403
3、查看测试工具是否有需要的接口，响应实例的返回字段是否符合参数要求。4、利用平台的文档中心和API测试工具，对接口进行测试、程序获取。参数说明：cid:商品分类ID，可以用cid=0来获得所有一级类目。为了进行此平台API的调用，首先我们需要做下面几件事情。更多API调用展示以及获取Key和secret请移步。2、 参考API文档里的接入方式和示例。1、 获取一个KEY。请求参数：cid=16。
接口作为返回值类型
bteatb的博客
05-23 577
接口作为返回值类型
FreeSWITCH RESTful API接口说明
最新发布
02-21
FreeSWITCH是一个开源的软交换平台，它提供了RESTful API接来与其进行交互。通过这些API接口，您可以实现对FreeSWITCH的配置、管理和监控等操作。 以下是FreeSWITCH RESTful API接口的一些说明： 1. API基本URL：通常，FreeSWITCH的API接口的基本URL为`http://<freeswitch-ip>:<api-port>/api/`，其中`<freeswitch-ip>`是FreeSWITCH服务器的IP地址，`<api-port>`是API接口的端口号。 2. 认证和授权：为了使用API接口，您需要进行认证和授权。通常，您可以在请求头中添加相应的认证信息，例如使用基本身份验证（Basic Authentication）或令牌（Token）。 3. API文档：FreeSWITCH提供了详细的API文档，您可以在其中找到每个API接口的详细说明、参数和返回值等信息。您可以通过访问`http://<freeswitch-ip>:<api-port>/api/help`来查看API文档。 4. 常见API接口：以下是一些常见的FreeSWITCH API接口： - `status`: 获取FreeSWITCH服务器的状态信息。 - `sofia/status`: 获取SIP网关（Sofia）的状态信息。 - `sofia/gateway`: 配置SIP网关。 - `conference`: 创建、管理和控制会议。 - `originate`: 发起呼叫。 - `callcontrol`: 控制呼叫，如挂断、保持、转移等。 - `voicemail`: 管理语音信箱。 您可以在API文档中找到这些接口的详细说明和使用方法。 5. 示例代码：以下是一个使用Python的示例，演示如何使用FreeSWITCH的RESTful API接口 ```python import requests base_url = "http://<freeswitch-ip>:<api-port>/api/" username = "your-username" password = "your-password" 获取FreeSWITCH服务器状态 def get_server_status(): url = base_url + "status" response = requests.get(url, auth=(username, password)) return response.json() #_url + "conference" data = { "name": name } response = requests.post(url, json=data, auth=(username, password)) return response.json() # 示例调用 server_status = get_server_status() print(server_status) conference = create_conference("my-conference") print(conference) ``` 以上是对FreeSWITCH RESTful API接口的简要介绍。如果您需要更详细的信息，请参考FreeSWITCH的官方文档或API文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值