Get API account information
API
API アカウント情報を取得
GET
Get API account information
呼び出しに使用した API キーに対応するアカウントの識別情報——数値の
apiId、名称、アカウント種別、主要連絡先メールアドレス、およびアカウントが現在ブロックされているかどうか——を返します。
apiId は、Return Helper がすべての webhook 通知で送信する RETURNHELPER-API-ID ヘッダーと同じ値です。1 台のサーバーで複数の Return Helper アカウントの通知を受信する場合は、API キーごとに本エンドポイントを 1 回ずつ呼び出し、apiId とアカウントの対応表を自社側に保存したうえで、そのヘッダーで各通知を振り分けてください。
関連
- Webhooks → 通知ヘッダー — 受信通知における
apiIdの位置。 - Notification Endpoint を一覧取得 — このアカウントに登録されている通知エンドポイント。
承認
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.