請求方式說明

FIRST LINE 採用 RESTful 為主設計 API,而使用到的 HTTP 請求方法共有四種方式:

請求示範例

下方為使用 POST 請求新增一個客戶的 postman 示意範例

{
    "membership_no":"R0000555",
    "identity_no":"A000000002",
    "gender":0,
    "first_name":"陳",
    "last_name":"大華",
    "birth_at":"1990-01-01"
}

在 Postman 中,建議使用 Body 選擇「raw」並直接輸入JSON。這樣可以避免 Postman 誤將數值轉換為字串,進而防止某些欄位在驗證時出現錯誤。

表頭

表頭的部分有三個,下面逐一解釋:

{
    "Authorization":"YOUR_TOKEN",
    "Content-Type": "application/json",
    "Accept":"application/json",
}

其他方法

GET \ DELETE

GETDELETE 依此類推,選用對應的 postman 請求方法即可。

PUT

因不支持直接使用 Http PUT 請求。所以,當需要進行PUT請求的時候,請使用POST方法替代,並確保附加_method="put"這一參數。

{
    "membership_no":"R0000567",
    "identity_no":"A000000001",
    "gender":0,
    "first_name":"王",
    "last_name":"小明",
    "birth_at":"1999-09-09"
}

錯誤代碼

採用標準 HTTP 狀態碼,由 RFC 2616 規範定義的,並得到 RFC 2518RFC 2817RFC 2295RFC 2774RFC 4918 等規範擴充。所有狀態碼被分為五類,狀態碼的第一個數字代表了回應的五種狀態之一。所示的訊息短語是典型的,但是可以提供任何可讀取的替代方案。 除非另有說明,狀態碼是HTTP/1.1標準(RFC 7231)的一部分。

Last updated