同意情報を取得

GEThttps://api.omise.co/consent

アカウントの同意情報を取得します。このエンドポイントは、認証されたアカウントの現在の同意ステータスと設定の詳細を返します。

---

リクエストパラメータ

このエンドポイントにはパラメータは必要ありません。

---

レスポンス

200

リクエスト成功

ステータスと設定の詳細を含む同意オブジェクトを返します。

同意オブジェクトに含まれる情報:

• object - 文字列値 "consent"
• id - 同意識別子
• location - APIエンドポイントパス "/consent"
• consented - 同意が与えられたかどうかを示すブール値
• consented_at - 同意が与えられたタイムスタンプ（ISO 8601）
• created_at - 同意レコードの作成タイムスタンプ（ISO 8601）

400

不正なリクエスト

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

一般的な原因:

• 無効なリクエスト形式
• 不正なリクエストヘッダー

401

認証エラー

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

一般的な原因:

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

404

見つかりません

アカウントの同意レコードが見つかりません。

一般的な原因:

• アカウントに同意が設定されていない
• アカウントに同意要件がない

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/consent \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

consent = Omise::Consent.retrieve

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

consent = omise.Consent.retrieve()

Node.js

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

const consent = await omise.consent.retrieve();

PHP

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

$consent = OmiseConsent::retrieve();

Java

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

Consent consent = client.consent().get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var consent = await client.Consent.Get();

Go

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

consent, _ := client.Consent().Get()

---

🔑API認証情報

▼

試してみる

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