APIバージョンを更新

PATCHhttps://api.omise.co/account/api_version

アカウントのデフォルトAPIバージョンを更新します。APIバージョンはレスポンス形式と利用可能な機能を決定します。更新前にAPIバージョン一覧エンドポイントを使用して、利用可能なバージョンを確認してください。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`api_version`STRING(required)

アカウントのデフォルトとして設定するAPIバージョン。APIバージョン一覧エンドポイントで返される有効なバージョンである必要があります。

Example:"2019-05-29"

---

レスポンス

200

更新成功

新しいAPIバージョン設定を含む更新されたアカウントオブジェクトを返します。

更新されたアカウントオブジェクトには以下が含まれます:

• id - アカウント識別子
• api_version - 更新されたデフォルトAPIバージョン
• email - アカウントのメールアドレス
• country - ISO 3166の2文字の国コード
• currency - ISO 4217の3文字の通貨コード
• その他すべてのアカウントフィールド（webhook_uri、supported_currenciesなど）

400

不正なリクエスト

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

一般的な原因:

• 無効なAPIバージョンが指定された
• api_versionパラメータが欠落
• APIバージョン形式が不正

401

認証失敗

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

一般的な原因:

• Authorizationヘッダーがない
• 無効な秘密キー
• 秘密キーの代わりに公開キーを使用
• 不正なHTTP Basic Auth形式

404

見つからない

指定されたAPIバージョンが存在しません。

一般的な原因:

• APIバージョン文字列が有効なバージョンではない
• バージョン識別子のタイプミス
• バージョンが非推奨になり、利用できなくなった

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/account/api_version \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "api_version=2019-05-29"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = Omise::Account.update_api_version(
  api_version: '2019-05-29'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = omise.Account.update_api_version(
    api_version='2019-05-29'
)

Node.js

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

const account = await omise.account.updateApiVersion({
  api_version: '2019-05-29'
});

PHP

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

$account = OmiseAccount::updateApiVersion([
    'api_version' => '2019-05-29'
]);

Java

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

Account account = client.account().updateApiVersion()
    .apiVersion("2019-05-29")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var account = await client.Account.UpdateApiVersion(new UpdateApiVersionRequest
{
    ApiVersion = "2019-05-29"
});

Go

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

account, _ := client.Account().UpdateApiVersion(&operations.UpdateApiVersion{
    ApiVersion: "2019-05-29",
})

---

試してみる

必須 - 1項目

▼

api_version(必須)

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