チェーンキー一覧を取得

GEThttps://api.omise.co/chains/{id}/keys

チェーン接続のAPIキー一覧を取得します。サブマーチャントの代わりに操作を行う際の認証に使用できる、サブマーチャントアカウントに関連付けられたキーのページネーション付きリストを返します。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 1 フィールドパスパラメータ

▼

`id`STRING(required)

パターン /acch(_test)?_[0-9a-z]+/ に一致するチェーン識別子。URLパスで指定します。

Example:"acch_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なチェーンIDである必要があります

追加 - 5 フィールドクエリパラメータ

▼

---

レスポンス

200

取得成功

キー一覧の取得に成功しました。メタデータを含むページネーション付きリストを返します。

レスポンス構造:

• object - 常に"list"を返します
• data - キーオブジェクトの配列
• limit - 1ページあたりのレコード数
• offset - スキップされたレコード数
• total - フィルタに一致するキーの総数

400

不正なリクエスト

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

一般的な原因:

• 無効なチェーンID形式
• from/toパラメータの日付形式が無効
• ページネーションパラメータが無効

401

認証エラー

認証に失敗しました。APIキーが無効または不足しています。

一般的な原因:

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

404

見つかりません

指定されたIDのチェーンが見つかりません。

一般的な原因:

• 無効なチェーンID形式
• チェーンが存在しない
• チェーンが別のアカウントに属している
• ライブチェーンIDでテストキーを使用（またはその逆）

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/chains/acch_test_5xuy4w91xqz7d1w9u0t/keys \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = Omise::Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')
keys = chain.keys(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = omise.Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')
keys = chain.keys(limit=20, offset=0)

Node.js

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

const keys = await omise.chains.listKeys('acch_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$chain = OmiseChain::retrieve('acch_test_5xuy4w91xqz7d1w9u0t');
$keys = $chain->keys([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Key> keys = client.chains().listKeys("acch_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var keys = await client.Chains.ListKeys("acch_test_5xuy4w91xqz7d1w9u0t", new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

keys, _ := client.Chains().ListKeys("acch_test_5xuy4w91xqz7d1w9u0t", &omise.ListParams{
    Limit:  20,
    Offset: 0,
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	パラメータの欠落または無効	パラメータの値と形式を確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	チェーンが見つからない	チェーンIDが正しく存在するか確認
invalid_date_format	日付形式の検証に失敗	ISO 8601形式（YYYY-MM-DDTHH:MM:SSZ）を使用

キーオブジェクトのフィールド

フィールド	型	説明
object	string	常に"key"を返します
id	string	一意のキー識別子
livemode	boolean	本番環境とテスト環境のインジケーター
secret	boolean	シークレットキーかどうか
created_at	string	キー作成タイムスタンプ（ISO 8601）

---

試してみる

追加 - 5項目

▼

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