Get API account information
API
取得 API 帳戶資訊
GET
Get API account information
回傳您所使用的 API Key 對應帳戶的識別資訊——數字型的
apiId、名稱、帳戶類型、主要聯絡電子郵件,以及該帳戶目前是否被封鎖。
apiId 與 Return Helper 在每則 webhook 通知中送出的 RETURNHELPER-API-ID 標頭為相同的值。若同一台伺服器會接收多個 Return Helper 帳戶的通知,請為每組 API Key 各呼叫本端點一次,在您端保存 apiId → 帳戶的對應關係,再依該標頭將每則通知路由到正確的帳戶。
相關
- Webhooks → 通知標頭 —
apiId在傳入通知中出現的位置。 - 列出 Notification Endpoints — 此帳戶已註冊的通知端點。
授權
Your API key
Your API token — keep this private
回應
Success
Identifier of the API account. Sent as the RETURNHELPER-API-ID header on every webhook notification.
範例:
1234
Account type. Always "USER" for accounts calling the User API.
範例:
"USER"
Account name. Sent as the RETURNHELPER-API-NAME header on every webhook notification.
範例:
"Acme Returns"
Primary contact email of the account.
範例:
"user@example.com"
True when the account is blocked and API calls are rejected.