淘寶開放平台

一、簡介

　　 淘寶開放平台是基於淘寶各類電子商務業務的開放平台，提供外部合作伙伴參與服務淘寶用戶的各類原材料，例如API、賬號體系
、數據安全等。它是大淘寶電子商務基礎服務的重要開放途徑，將推動各行各業定制、創新、進化，並最終促成新商業文明生態圈的建立。

　　特點

　　1、業務母體強大、商機無限
　　2、開放規模大、程序深、限制小
　　3、盈利模式清晰
　　4、合作形式豐富

　　應用權限說明

　　每個應用都有自身的證書權限，權限決定了應用可調用的API以及可申請的API.在應用申請成功后，可直接在“開放應用平台-應用管理-概述”頁面查看。如下。同時每個應用可以申請的接口 也在這個頁面，該頁面有顯示的，表示該接口當前應用可申請。其余未顯示接口表示該應用類型，無法申請。
    “￥基礎” 這個標志表示調用該api需要收費，直接點擊可以看到具體收費規則；如是“￥免費” 則表示，調用該api 不需收費。不需要授權” 表示調用該api 獲取數據，不需要賣家授權，具體到api上，即調用該api時不需要傳人系統參數session（即access_token）；如果這里標志是 “需要授權” ，則在調用前還需要獲取賣家授權。

二、開發文檔

1、API調用協議

調用流程　　　

根據TOP的協議：填充參數 > 生成簽名 > 拼裝HTTP請求 > 發起HTTP請求> 得到HTTP響應 > 解釋json/xml結果，以下是大體的調用過程示意圖：

 

調用環境

調用環境	服務地址(HTTP)	服務地址(HTTPS)
沙箱環境	http://gw.api.tbsandbox.com/router/rest	https://eco.taobao.com/router/rest
正式環境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest
海外環境	http://api.taobao.com/router/rest	https://api.taobao.com/router/rest

公共參數

調用任何一個API都必須傳入的參數，目前支持的公共參數有：

參數名稱	參數類型	是否必須	參數描述
method	String	是	API接口名稱
app_key	String	是	TOP分配給應用的AppKey。這里要注意正式環境和沙箱環境的AppKey是不同的（包括AppSecret），使用時要注意區分；進入開放平台控制台“應用管理-概覽” 和 “應用管理-沙箱環境管理”可分別查看正式環境及沙箱環境的AppKey、AppSecret
session	String	否	用戶登錄授權成功后，TOP頒發給應用的授權信息，詳細介紹請點擊這里。當此API文檔的標簽上注明：“需要授權”，則此參數必傳；“不需要授權”，則此參數不需要傳；“可選授權”，則此參數為可選。
timestamp	String	是	時間戳，格式為yyyy-MM-dd HH:mm:ss，時區為GMT+8，例如：2016-01-01 12:00:00。淘寶API服務端允許客戶端請求最大時間誤差為10分鍾。
format	String	否	響應格式。默認為xml格式，可選值：xml，json。
v	String	是	API協議版本，可選值：2.0。
partner_id	String	否	合作伙伴身份標識。
target_app_key	String	否	被調用的目標AppKey，僅當被調用的API為第三方ISV提供時有效。
simplify	Boolean	否	是否采用精簡JSON返回格式，僅當format=json時有效，默認值為：false。
sign_method	String	是	簽名的摘要算法，可選值為：hmac，md5。
sign	String	是	API輸入參數簽名結果，簽名算法參照下面的介紹。

業務參數

API調用除了必須包含公共參數外，如果API本身有業務級的參數也必須傳入，每個API的業務級參數請考API文檔說明。

簽名算法　

　　為了防止API調用過程中被黑客惡意篡改，調用任何一個API都需要攜帶簽名，TOP服務端會根據請求參數，對簽名進行驗證，簽名不合法的請求將會被拒絕。TOP目前支持的簽名算法有兩種：MD5(sign_method=md5)，HMAC_MD5(sign_method=hmac)，簽名大體過程如下：

• 對所有API請求參數（包括公共參數和業務參數，但除去sign參數和byte[]類型的參數），根據參數名稱的ASCII碼表的順序排序。如：foo:1, bar:2, foo_bar:3, foobar:4排序后的順序是bar:2, foo:1, foo_bar:3, foobar:4。
• 將排序好的參數名和參數值拼裝在一起，根據上面的示例得到的結果為：bar2foo1foo_bar3foobar4。
• 把拼裝好的字符串采用utf-8編碼，使用簽名算法對編碼后的字節流進行摘要。如果使用MD5算法，則需要在拼裝的字符串前后加上app的secret后，再進行摘要，如：md5(secret+bar2foo1foo_bar3foobar4+secret)；如果使用HMAC_MD5算法，則需要用app的secret初始化摘要算法后，再進行摘要，如：hmac_md5(bar2foo1foo_bar3foobar4)。
• 將摘要得到的字節流結果使用十六進制表示，如：hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”

　　說明：MD5和HMAC_MD5都是128位長度的摘要算法，用16進制表示，一個十六進制的字符能表示4個位，所以簽名后的字符串長度固定為32個十六進制字符。

public static String signTopRequest(Map<String, String> params, String secret, String signMethod) throws IOException {
    // 第一步：檢查參數是否已經排序
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);

    // 第二步：把所有參數名和參數值串在一起
    StringBuilder query = new StringBuilder();
    if (Constants.SIGN_METHOD_MD5.equals(signMethod)) {
        query.append(secret);
    }
    for (String key : keys) {
        String value = params.get(key);
        if (StringUtils.areNotEmpty(key, value)) {
            query.append(key).append(value);
        }
    }

    // 第三步：使用MD5/HMAC加密
    byte[] bytes;
    if (Constants.SIGN_METHOD_HMAC.equals(signMethod)) {
        bytes = encryptHMAC(query.toString(), secret);
    } else {
        query.append(secret);
        bytes = encryptMD5(query.toString());
    }

    // 第四步：把二進制轉化為大寫的十六進制(正確簽名應該為32大寫字符串，此方法需要時使用)
    return byte2hex(bytes);
}

public static byte[] encryptHMAC(String data, String secret) throws IOException {
    byte[] bytes = null;
    try {
        SecretKey secretKey = new SecretKeySpec(secret.getBytes(Constants.CHARSET_UTF8), "HmacMD5");
        Mac mac = Mac.getInstance(secretKey.getAlgorithm());
        mac.init(secretKey);
        bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}

public static byte[] encryptMD5(String data) throws IOException {
    return encryptMD5(data.getBytes(Constants.CHARSET_UTF8));
}

public static String byte2hex(byte[] bytes) {
    StringBuilder sign = new StringBuilder();
    for (int i = 0; i < bytes.length; i++) {
        String hex = Integer.toHexString(bytes[i] & 0xFF);
        if (hex.length() == 1) {
            sign.append("0");
        }
        sign.append(hex.toUpperCase());
    }
    return sign.toString();
}