Version: 1.0.0
S2S API 介接
合作夥伴與本平台之間的 Server-to-Server 介接。
所有 S2S API 都以 OAuth 2.0 Client Credentials Grant 認證。開始串接業務 API 前， 請依序完成下列兩步，確認憑證、授權與連線皆正常。
介接流程
- 取得 Client Token — 以 client 憑證換取 access token
- 串接測試(ping) — 帶著 token 呼叫 ping，驗證 token 與授權設定
ping 通過後即可串接其他業務 API。
環境變數
建議將下列值存為環境變數，不要寫死在 request 內。
| 變數 | 說明 |
|---|---|
auth-base-url | 認證服務位址 |
api-base-url | 業務 API 服務位址 |
s2s-client-id | 本平台配發的 client id |
s2s-client-secret | 本平台配發的 client secret |
client 憑證由本平台於介接作業開始時另行提供，請妥善保管，勿提交至版本控制或前端程式碼。
回應格式
所有 API 共用同一組回應外層。失敗時由 code、message、detail 帶回錯誤資訊。
Authentication
- HTTP: Bearer Auth
帶入上一支取得的 result.accessToken，格式 Authorization: Bearer {accessToken}。
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |