How to get access_token

❗️
注意
須先向 SHOPLINE 申請使用 OpenAPI，才會在管理員設定看到 API Auth 功能。
(如果是通過 Developer Center 對接的擴充功能 App，不需要申請使用 API Auth 權限，請參閱此文件取得 API access token )
If you would like to use OpenAPI, please apply for the permission from your correspondent SHOPLINE contact to enable API Auth in Staff Settings.

Settings > Staff Settings (設定 > 管理員設定 )

1517 — Step1
Create a new Staff, for Open API use purpose.

1499 — Step2 Set up an internal administrator or an E-mail of a cooperating vendor to create an administrator

1504 — Step1
Create a new administrator to use OpenAPI
建立一個新的管理員，來代表使用 OpenAPI

1507 — Step2
Set up an internal administrator or partner vendor E-mail to create an administrator
設定一個內部管理員或是協作廠商 E-mail 來建立管理員

1499 — Step3
Click the newly added administrator to edit
點選新增的管理員進行編輯

1493 — Step4
Click on API Auth
Select the API that requires authorization
點選 API Auth tap
選擇需要授權的 API

1509 — Step5
You can choose Expored At (expiration time), if you want to open to cooperating manufacturers, it is recommended to set an expiration time.
If Expored At is not selected, it means that the access_token will not expire
Finally, you can press Generate to generate access_token
可以選擇 Expired At (過期時間)，若是要開放給協作廠商，建議設定一個過期時間。
若不選擇 Expired At 則代表 access_token 不會過期
最後可以按下 Generate 產生 access_token

1508 — Step6
Finally, you can copy the Token and start using OpenAPI
最後可以複製 Token 開始使用 OpenAPI

(2024 年 1 月 10 日上線功能)

針對 Open API Token 設定 IP 白名單

產生 Token 後，才會顯示 +New IP Whitelist 按鈕
名稱長度最多 20 字元

一組 Token 最多可設定 20 組 IP 白名單

點擊操作的垃圾桶 icon 後，popup 訊息，確認後立即刪除
- 確認訊息：「確定刪除？一旦刪除將無法復原！」
- Confirmation popup：「Are you sure you want to delete this? Once it is deleted, it cannot be restored.」
點擊 Delete，popup 訊息，確認後立即刪除該 Token 以及底下所有 IP 白名單
- 確認訊息：「Are you sure?」
使用建議與注意事項
1. 建議幫不同合作廠商使用不同管理員 email 建立 Open API Token ，確保資安權責劃分
2. 若有設定 Expired At (過期時間)，只要 Token 過期就要將舊的 Token 刪除重新產生，此時之前建立的 IP 白名單也會一併刪除，店家重新取得 Token 後，要自行一組一組把 IP 白名單建進去，系統不會將過去的 IP 清單自動匯入

Updated 10 months ago