すべてのlinkのリスト表示

GEThttps://api.omise.co/links

アカウント内のすべてのpayment linkのページネーションされたコレクションを返します。日付範囲でフィルタリングし、ソート順を制御できます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Additional - 5 fieldsAdditional Parameters

▼

---

レスポンス

200

成功した取得

linkのリストが正常に取得されました。metadataを含むページネーションされたリストを返します。

レスポンス構造:

• object - 常に「list」を返します
• data - linkオブジェクトの配列
• limit - 1ページあたりのレコード数
• offset - スキップされたレコード数
• total - フィルタに一致するlinkの総数
• order - 適用されたソート順
• from - 適用された開始日フィルタ
• to - 適用された終了日フィルタ

400

Bad request

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

一般的な原因:

• 無効な日付形式（ISO 8601形式である必要があります）
• 無効なlimit値（最大値を超えている）
• 無効なorder値
• 不正なパラメータ

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なsecret key
• secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = Omise::Link.list(
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = omise.Link.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

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

const links = await omise.links.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

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

$links = OmiseLink::retrieve([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

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

ScopedList<Link> links = client.links().list()
    .limit(20)
    .offset(0)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var links = await client.Links.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0,
    Order = ListOrder.ReverseChronological
});

Go

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

links, _ := client.Links().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
    Order:  omise.ReverseChronological,
})

---

エラーおよび結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	パラメータが欠落または無効	パラメータの値と形式を確認してください
authentication_failure	無効なAPIキー	secret keyが正しいことを確認してください
invalid_date_format	日付形式の検証に失敗	ISO 8601形式を使用してください（YYYY-MM-DDTHH:MM:SSZ）

ページネーション

結果をページネーションするには:

• limitを使用してページサイズを制御します（最大100）
• offsetを使用してレコードをスキップします
• レスポンスのtotalを確認して利用可能な総レコード数を把握します
• 例: 1ページあたり20件で2ページ目 = offset=20&limit=20

---

試してみる

追加 - 5項目

▼