Webhookシークレットの一覧

GEThttps://api.omise.co/webhooks/secrets

アカウントのすべてのWebhook署名シークレットを一覧表示します。このエンドポイントを使用して、既存のシークレットを表示し、作成日を確認し、キーローテーションを管理します。実際のシークレット値は返されません。作成時に一度だけ表示されます。

---

リクエストパラメータ

オプション - 3項目ページネーションパラメータ

▼

`limit`INTEGER(optional)

ページあたりの返却シークレット数。

Example:20

Constraints:最小値: 1, 最大値: 100, デフォルト: 20

Default:20

`offset`INTEGER(optional)

ページネーション用にスキップするシークレット数。大きな結果セットをページネーションするためにlimitと一緒に使用します。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

---

レスポンス

200

取得成功

Webhookシークレットオブジェクトのページネーションされたリストを返します。セキュリティ上の理由から、実際のシークレット値はレスポンスに含まれません。

レスポンスに含まれるもの：

• object - オブジェクトタイプ（常に "list"）
• data - Webhookシークレットオブジェクトの配列
• limit - ページあたりの結果数
• offset - スキップされた結果の数
• total - シークレットの総数
• order - 適用されたソート順

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因：

• limitが最大値（100）を超過
• 無効なorderパラメータ
• offsetが負の値

401

認証エラー

認証に失敗しました。無効または欠落したAPIキーです。

一般的な原因：

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

5xx

サーバーエラー

サーバー側でエラーが発生しました。これはまれですが、適切に処理する必要があります。

対処方法：

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/webhooks/secrets \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = Omise::WebhookSecret.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

secrets = omise.WebhookSecret.list(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const secrets = await omise.webhookSecrets.list({
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$secrets = OmiseWebhookSecret::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<WebhookSecret> secrets = client.webhookSecrets().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var secrets = await client.WebhookSecrets.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

secrets, _ := client.ListWebhookSecrets(&operations.ListWebhookSecrets{
    Limit:  20,
    Offset: 0,
})

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
bad_request	無効なパラメータ	パラメータ値を確認
invalid_parameters	無効なページネーションパラメータ	limitとoffsetの値を確認

Webhookシークレットリストのフィールド

フィールド	説明
object	オブジェクトタイプ（常に "list"）
data	Webhookシークレットオブジェクトの配列
limit	ページあたりの項目数
offset	スキップされた項目数
total	シークレットの総数
order	適用されたソート順

Webhookシークレットオブジェクトのフィールド

フィールド	説明
object	オブジェクトタイプ（常に "webhook_secret"）
id	一意のシークレット識別子（whsec_*）
livemode	ライブモードのシークレットかどうか
created_at	ISO 8601形式の作成タイムスタンプ

---

🔑API認証情報

▼

試してみる

あなたのIP: ...読み込み中...