すべてのチェーンを取得

GEThttps://api.omise.co/chains

サブマーチャントチェーンアカウントのページネーション付きコレクションを返します。チェーンは、別のアカウントが代わりに課金を作成しアクションを実行することを承認したサブマーチャントを表します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

---

レスポンス

200

取得成功

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

レスポンス構造:

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

401

認証エラー

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chains = Omise::Chain.list(
  limit: 20,
  offset: 0
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chains = omise.Chain.list(
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

$chains = OmiseChain::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Chain> chains = client.chains().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var chains = await client.Chains.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

chains, _ := client.Chains().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
})

---

エラーと結果コード

一般的なエラーコード

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

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

フィールド	型	説明
object	string	常に"chain"を返します
id	string	/acch(_test)?_[0-9a-z]+/に一致するチェーン識別子
key	string	サブマーチャントの代わりにアクションを実行するための認証キー
email	string	サブマーチャントアカウントのメールアドレス
livemode	boolean	本番環境とテスト環境のインジケーター
revoked	boolean	チェーンアクセスが取り消されたかどうかを示す
created_at	string	作成タイムスタンプ（ISO 8601）

---

試してみる

追加 - 5項目

▼

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