API介面的要素以及API的作用說明

API測試Cris發表於2023-04-15

對於很多剛接觸的產品小白而言,API介面它是一個產品和研發領域的專業術語,大家可能在一些文章中都已經有接觸過API介面的概念。

實際上,API介面的應用現如今已經非常廣泛和成熟,這個概念主要活躍在公司內部的各系統之間的銜接和對接以及公司間合作的場景。

接下來我會從三個方面說明,相信各位認真讀完也能對API有一個更新的瞭解。

本文目錄:

一、API介面是什麼?

二、為什麼我們需要API介面?

三、API介面的核心、

API介面是什麼?

API介面:應用程式介面(API:Application Program Interface),它是一組定義、程式及協議的集合,透過 API 介面能夠實現計算機軟體和軟體之間的相互通訊。

其實換句話通俗點來說,就是將內部實現的功能封裝起來,就像一個盒子一樣只留出一個口子,人們接入這個口子那麼也就能使用這個功能。

呼叫的人可以很方便使用這些功能,並且可以不需要知道這些功能的具體實現過程,介面API就是按照作者規定的流程去呼叫這些功能。

為什麼我們需要API介面?

背景:我們的業務系統涉及到多方多面,如果要一個公司或者一個系統把所有業務都做完,那可想而知,工作量是相當之巨大,並且如果其他系統或公司有更好的運算邏輯,那我們在設計功能的時候可以考慮利用介面進行開發。

核心需求:利用現有介面可以降低開發的成本,縮短開發的成本。

API介面的核心

1. 介面地址【v;18870288846

2. 請求引數

名稱 型別 必須 描述
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=652874751412&is_promotion=1

引數說明:num_iid:淘寶商品ID
is_promotion:是否獲取取促銷價


返回結果

名稱 型別 必須 示例值 描述
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 寶貝連結
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 【更多介面v;18870288846
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 商品屬性圖片列表
property_alias

String 0 20509:9974422:36;1627207:28326:紅色;20509:9975710:38;1627207:28326:紅色;20509:9981357:40;1627207:28326:紅色 銷售屬性值別名。格式為pid1:vid1:alias1;pid1:vid2:alia2。
props

Mix 0 [{ "name": "產地","value": "中國" }] 商品屬性
total_sold

Int 0
skus

skus[] 0 商品規格資訊列表
seller_id

Int 0 2844096782 賣家ID
sales

Int 0 138 銷量
shop_id

Int 0 151372205 店鋪ID
props_list

Mix 0 {20509:9974422: 尺碼:36} 商品屬性
seller_info

seller_info[] 1 賣家資訊
tmall

Boolean 0 false 是否天貓
error

String 0 錯誤資訊
warning

String 0 警告資訊
url_log

Mix 0 []
favcount

Int 0 0
fanscount

Int 0 0
method

String 0 item_tmall:pget_item
promo_type

String 0
props_img

Mix 0 1627207:28326": "//img.alicdn.com/imgextra/i2/2844096782/O1CN01VrjpXt1zyCc9DvERE_!!2844096782.jpg 屬性圖片
shop_item

Mix 0 []
relate_items

Mix 0 []
文章內容有限,歡迎私信交流溝通!


來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/70028219/viewspace-2946015/,如需轉載,請註明出處,否則將追究法律責任。

相關文章