API 說明
Last updated
Last updated
API 與 Webhook 串接須知
串接 API 及 Webhook 須由工程與技術人員完成整合，FIRST LINE 客服不提供相關技術服務。請自行評估後進行操作，若需要額外技術支持，可參考我們的進階付費項目以獲取協助。
使用 API 需要透過 Token 驗證，而每位專員的 Token 皆為獨立，彼此不互相影響與銷毀。而 Token 能使用的 API 範圍跟著擁有員工資料的權限，如一個「專員」權限的員工 token，則多個管理相關 API 將無法使用。
你可以透過以下兩種方式取得：
To use the API, authentication is required through a token. Each agent has an independent token, and they do not interfere with or invalidate each other. The scope of API access for a token is determined by the employee data permissions. For instance, a token with "agent" permissions will be unable to access various management-related APIs.
It can be obtained through two methods:
管理者登入 FIRST LINE 後，依序前往左側選單中「系統」 > 「員工」，找到欲使用 API 之員工帳號，點擊 「產生」，便會產生永久的權杖，而若是重新產生新的金鑰，之前屬於該員工的舊權杖將立即失效。
When an admin logs into FIRST LINE, navigate to the "System" > "Employee" option in the left menu. Locate the employee account for which you want to generate a token and click on "Generate." This action will create a permanent token. If a new key is generated, the old token belonging to that employee will immediately become invalid.
你也能透過使用者帳密與密碼來產生新的權杖，使用方式如下，每次取的新的 Token，舊有 Token 將立即失效。依據使用情境與安全性考量下，你只需要依據設定週期執行取得即可。
You can also generate a new token through the API using the user's username and password. The process is as follows: each time a new token is obtained, the old token will immediately become invalid. Depending on the usage scenario and security considerations, it is recommended to obtain a new token based on the configured period.
POST https://{API_HOST}/api/v1/auth
ttl
integer
金鑰過期時間，單位為分鐘，預設 60分鐘過期。輸入 52560000分鐘達到長效期使用。
password*
string
使用者密碼
name*
string
使用者帳號
PUT https://{API_HOST}/api/v1/auth
name
string
使用者帳號。
password
string
使用者密碼。
ttl
number
金鑰過期時間，單位為分鐘，預設 60 分鐘過期。
PUT https://{API_HOST}/api/v1/auth/logout
註銷當前使用之權杖，相當於登出此使用者。
name
string
使用者帳號。
password
string
使用者密碼。
取得 Token 後，您可以透過該 Token 執行各種對應帳號擁有系統權限的 API 操作。FIRST LINE 的 API 請求可透過以下兩種方式之一驗證權杖（access token）。
After obtaining the token, you can perform various API operations corresponding to the system permissions associated with the account. FIRST LINE API requests can be authenticated using one of the following two methods with the access token.
Authorization: Bearer eyJhbGciOiJIUzI1NiI...
https://{API_HOST}/api/v1/some-what?token=eyJhbGciOiJIUzI1NiI...
