Skip to main content

Server-API

API 通訊技術​

SHOPLINE Payments Server-API 採用通用的 HTTPS 方式進行通訊，HTTP 請求電文分為 header 通用電文及 body 業務電文，body 區域電文採用JSON資料結構，需設定http Content-Type為application/json

API認證機制​

  1. Server-API 使用 apiKey 金鑰來驗證請求。 您可以 SHOPLINE Payments Payment Center 中檢視和管理您的 apiKey 金鑰。
  2. 您的 apiKey 金鑰具有許多權限，因此請務必確保它們的安全性！ 請勿在可公開存取的區域（例如 GitHub、用戶端程式碼等）共用您的秘密 apiKey 金鑰。
  3. Server-API 的身份驗證是透過 [HTTP Header apiKey] 參數進行。 您需要在每個 API 請求 Header 中設定次參數，SHOPLINE Payments 平台將根據 apiKey 驗證您的身份。
  4. 所有 API 請求都必須透過HTTPS 發出。 通過純 HTTP 進行的通話將會失敗。 未經身份驗證的 API 請求也會失敗。

環境URL資訊​

範例​

{
    "id":"00010102714941393270727680000202110",
    "type":"trade.succeeded",
    "data":{
       "paymentError":null,
       "tradeOrderId":"10010102714941391738628956160",
       "channelDealId":"pay_ifrlzoaf62s2blthtl6exd2uza",
       "payment":{
          "last4":"1111",
          "brand":"Visa"
       },
       "subStatus":"",
       "status":"SUCCEEDED"
    }
}