Skip to main content
GET
Get API account information
此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問,請參閱英文版本
回傳您所使用的 API Key 對應帳戶的識別資訊——數字型的 apiId、名稱、帳戶類型、主要聯絡電子郵件,以及該帳戶目前是否被封鎖。 apiId 與 Return Helper 在每則 webhook 通知中送出的 RETURNHELPER-API-ID 標頭為相同的值。若同一台伺服器會接收多個 Return Helper 帳戶的通知,請為每組 API Key 各呼叫本端點一次,在您端保存 apiId → 帳戶的對應關係,再依該標頭將每則通知路由到正確的帳戶。

授權

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

回應

Success

apiId
integer<int64>

Identifier of the API account. Sent as the RETURNHELPER-API-ID header on every webhook notification.

範例:

1234

apiTypeCode
string | null

Account type. Always "USER" for accounts calling the User API.

範例:

"USER"

apiName
string | null

Account name. Sent as the RETURNHELPER-API-NAME header on every webhook notification.

範例:

"Acme Returns"

primaryEmail
string | null

Primary contact email of the account.

範例:

"user@example.com"

isBlocked
boolean

True when the account is blocked and API calls are rejected.