三方接口設計是實現系統功能的關鍵環節。設計一個安全、高效且易于維護的接口調用方案，對于保障系統穩定性、數據安全性和用戶體驗至關重要。

一、接口設計的基本原則

1. 安全性：確保接口數據的安全性，防止數據篡改、過期、重復提交等問題。

2. 可靠性：接口應具備高可用性，能夠在高并發、高負載環境下穩定運行。

3. 易用性：接口設計應簡潔明了，易于第三方系統調用和維護。

4. 可擴展性：接口設計應考慮到未來的擴展需求，便于增加新功能或調整現有功能。

二、設計方案

1. API密鑰生成與管理

• AK（Access Key）：用于標識應用，是公開的信息，主要用于標示用戶或應用身份。

• SK（Secret Key）：加密認證密鑰，必須嚴格保密。通過AK和SK的組合使用，進行請求的加密驗證，確保請求發送者的身份合法性。

2. 接口鑒權機制

• 客戶端簽名：客戶端使用AK和請求參數（包括但不限于路徑、方法、參數、時間戳等）生成簽名，并將該簽名放入請求頭中，以進行身份驗證。

• 時間戳：每個請求都需附帶當前時間的時間戳，用于校驗請求的時效性，通常有效期設置為5分鐘以內。

• 流水號（Nonce）：每個請求生成一個唯一的臨時隨機數，確保在有效期內不允許重復提交，防止重復攻擊。

3. 回調地址設置

• 第三方應用回調地址：要求第三方應用提供回調地址，用于接收異步通知和回調結果，確保數據交互的可靠性和及時性。

4. 接口API設計

• URL設計：明確接口的地址結構，便于第三方系統調用。

• HTTP方法：規定使用GET、POST、PUT、DELETE等HTTP方法，明確各方法的用途和適用場景。

• 請求參數：詳細列出每個接口所需的請求參數，包括必填項和可選項，以及參數的類型和格式。

• 響應格式：統一接口響應的數據格式，如JSON，并明確響應中的字段含義和數據類型。

5. 權限劃分與認證

• appId：應用的唯一標識，用于標識開發者賬號或應用實例。

• appKey：公開的密鑰，相當于賬號，用于在請求中標識應用身份。

• appSecret：私密密鑰，相當于密碼，用于加密和權限控制。

• token：臨時令牌，具有時效性，用于驗證用戶或應用的身份。在首次驗證（如登錄場景）時，使用appKey和appSecret申請accessToken，并設置失效時間。后續每次請求都需帶上該token以表明權限通過。

6. appKey + appSecret機制

• 首次驗證：在首次驗證時，使用appKey和appSecret來申請accessToken，該token帶有失效時間，用于后續的請求認證。

• 權限控制：針對同一業務的不同權限需求（如只讀權限和讀寫權限），可通過分配不同的appKey和appSecret來實現權限劃分。每個appKey和appSecret對應不同的權限級別。

7. 簡化場景

• 開放性接口：如百度、谷歌地圖API等，可省去appId和appKey，將三者合一（appId = appKey = appSecret），此時appId主要用于統計用戶調用接口的次數。

• 單一權限配置：當每個用戶有且僅有一套權限配置時，可去掉appKey，直接使用appId和appSecret進行身份認證和權限控制。

• 簽名驗證：在調用方向服務提供方發起請求時，帶上（appKey、時間戳timeStamp、隨機數nonce、簽名sign）。簽名sign可使用（AppSecret + 時間戳 + 隨機數）通過sha1、md5等算法生成。服務提供方收到請求后，生成本地簽名并與收到的簽名進行比對，一致則校驗成功。

8. 簽名字段說明

• appId和appSecret：唯一標識和密鑰，為不同的調用方分配不同的appId和appSecret。

• 時間戳（timeStamp）：以服務端當前時間為準，設置有效期（如5分鐘以內），用于校驗請求的時效性。

• 流水號（nonce）：臨時隨機數，確保在有效期內不允許重復提交，防止重復攻擊。

• 簽名字段（sign）：客戶端傳遞的簽名信息，包含appId和sign字段，用于驗證身份和防止參數篡改。服務提供方通過驗證簽名來確保請求的安全性和合法性。

三、接口設計的具體步驟

1. API密鑰生成與管理

• 生成密鑰：使用隨機字符串或UUID生成AK和SK，確保密鑰的唯一性和安全性。

• 存儲密鑰：將生成的AK和SK存儲在數據庫或其他持久化存儲中，便于管理和查詢。

• 分發密鑰：通過界面、API或自助注冊流程向第三方系統提供AK和SK。

• 定期輪換密鑰：定期更換SK，以減少密鑰泄露的風險。

// 生成API密鑰

public class ApiKeyGenerator {

    public static String generateAccessKey() {

        return UUID.randomUUID().toString();

    }

    public static String generateSecretKey() {

        return Base64.getEncoder().encodeToString(new byte[16]);

    }

}

2. 接口鑒權

接口鑒權是驗證請求合法性的重要環節。可通過以下方式進行鑒權：

• 簽名驗證：客戶端使用AK和請求參數生成簽名，并在請求頭中攜帶簽名信息。服務端接收請求后，驗證簽名的合法性。

• Token驗證：客戶端首次驗證時，使用AK和SK申請Token。后續請求中攜帶Token，服務端驗證Token的有效性。

// 簽名驗證

public class SignAuthInterceptor implements HandlerInterceptor {

    private String secretKey;

    public SignAuthInterceptor(String secretKey) {

        this.secretKey = secretKey;

    }

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String timestamp = request.getHeader("timestamp");

        String nonceStr = request.getHeader("nonceStr");

        String signature = request.getHeader("signature");

        if (isExpired(timestamp) || isNonceUsed(nonceStr)) {

            throw new BusinessException("Invalid request");

        }

        String calculatedSignature = calculateSignature(request, secretKey);

        if (!signature.equals(calculatedSignature)) {

            throw new BusinessException("Invalid signature");

        }

        return true;

    }

    private boolean isExpired(String timestamp) {

        long currentTime = System.currentTimeMillis() / 1000;

        long requestTime = Long.parseLong(timestamp);

        return currentTime - requestTime > 60; // 有效期60秒

    }

    private boolean isNonceUsed(String nonceStr) {

        // 檢查nonceStr是否已使用，可用Redis等存儲

        return false;

    }

    private String calculateSignature(HttpServletRequest request, String secretKey) throws UnsupportedEncodingException {

        Map<String, Object> params = new HashMap<>();

        Enumeration<String> parameterNames = request.getParameterNames();

        while (parameterNames.hasMoreElements()) {

            String name = parameterNames.nextElement();

            String value = request.getParameter(name);

            if (!"signature".equals(name)) {

                params.put(name, URLEncoder.encode(value, "UTF-8"));

            }

        }

        List<String> keys = new ArrayList<>(params.keySet());

        Collections.sort(keys);

        StringBuilder sb = new StringBuilder();

        for (String key : keys) {

            sb.append(key).append("=").append(params.get(key)).append("&");

        }

        sb.append(secretKey);

        return DigestUtils.md5DigestAsHex(sb.toString().getBytes("UTF-8"));

    }

}

3. 接口API設計

接口API設計包括URL、HTTP方法、請求參數和響應格式等細節。設計時應遵循RESTful原則，使接口更加簡潔、易于理解。

• URL設計：使用簡潔、描述性的URL路徑，如/api/resources表示獲取資源列表。

• HTTP方法：使用GET、POST、PUT、DELETE等HTTP方法分別表示不同的操作。

• 請求參數：明確請求參數的類型、必填項和默認值，便于調用者理解和使用。

• 響應格式：采用統一的響應格式，如JSON，包含狀態碼、消息和數據等字段。

// API接口設計

@RestController

@RequestMapping("/api/resources")

public class ResourceController {

    @GetMapping

    public Result<List<Resource>> getResources(@RequestParam(defaultValue = "1") int page,

                                               @RequestParam(defaultValue = "10") int limit) {

        // 實現獲取資源列表的邏輯

        List<Resource> resources = new ArrayList<>();

        return Result.success(resources);

    }

    @PostMapping

    public Result<Resource> createResource(@RequestBody Resource resource) {

        // 實現創建資源的邏輯

        return Result.success(resource);

    }

    @PutMapping("/{resourceId}")

    public Result<Void> updateResource(@PathVariable String resourceId, @RequestBody Resource resource) {

        // 實現更新資源的邏輯

        return Result.success();

    }

    @DeleteMapping("/{resourceId}")

    public Result<Void> deleteResource(@PathVariable String resourceId) {

        // 實現刪除資源的邏輯

        return Result.success();

    }

}

public class Result<T> {

    private int code;

    private String message;

    private T data;

    public static <T> Result<T> success(T data) {

        Result<T> result = new Result<>();

        result.setCode(200);

        result.setMessage("Success");

        result.setData(data);

        return result;

    }

    // 。。。

}

4. 安全性考慮

• 使用HTTPS：保護數據傳輸安全，防止中間人攻擊。

• 請求驗簽：服務端進行校驗和鑒權，確保請求的合法性。

• 敏感數據加密傳輸：使用TLS加密敏感數據，防止數據泄露。

• 防止重放攻擊：使用Nonce和Timestamp，確保請求的唯一性和時效性。

// 防止重放攻擊

public class AntiReplayInterceptor implements HandlerInterceptor {

    private RedisTemplate<String, String> redisTemplate;

    public AntiReplayInterceptor(RedisTemplate<String, String> redisTemplate) {

        this.redisTemplate = redisTemplate;

    }

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String nonceStr = request.getHeader("nonceStr");

        String timestamp = request.getHeader("timestamp");

        if (isNonceUsed(nonceStr) || isExpired(timestamp)) {

            throw new BusinessException("Invalid request");

        }

        return true;

    }

    private boolean isNonceUsed(String nonceStr) {

        return redisTemplate.hasKey(nonceStr);

    }

    private boolean isExpired(String timestamp) {

        long currentTime = System.currentTimeMillis() / 1000;

        long requestTime = Long.parseLong(timestamp);

        return currentTime - requestTime > 60; // 有效期60秒

    }

}

三、接口調用的最佳實踐

1. 合理使用Token：使用Token減少用戶名和密碼的傳輸次數，提高接口調用的安全性。

2. 錯誤處理：在調用接口時，應妥善處理可能出現的錯誤，如網絡異常、參數錯誤等。

3. 日志記錄：記錄接口調用的日志，便于問題排查和性能分析。

4. 接口限流：對接口進行限流，防止惡意攻擊或濫用資源。

原文來源：https://mp.weixin.qq.com/s/xz0wNkpHXuSFx1BZH-RK9g