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.