バージョン管理

Omiseでは定期的にAPIのアップデートを行っています。アップデートは既存のインテグレーションに影響を与えず、加盟店様のアカウントに自動的に反映されます。

新しいバージョンに従来と異なるアトリビュート名の使用や大幅な変更がある場合に限り、更新後のAPIが過去のリリース分に対応していない事があります。その場合は新規APIが作成されます。
ユーザーは、現在お使いいただいているダッシュボードの状況に応じて、ご自身のお好きなタイミングで無料で更新いただけます。テストモードとライブモードを別々のタイミングで更新いただくことも可能です。

HTTPのヘッダーにOmise-Versionを指定すれば、ダッシュボード内に設定しているAPIバーションを上書きできます。(例: ダッシュボード内は2016-01-01に設定している時に、2015-12-01を使いたい場合はヘッダーにOmise-Version: 2015-12-01と指定すれば2015-12-01になります。)
リクエストされたAPIバージョンには、現在ご利用いただいているバージョンよりも自動的に高い優先順位が付与されるので、テストバージョンをご利用いただく際にアカウントそのものを更新する手間が省けるため、ダウンタイムを気にせずに新しいAPIをお試しいただけます。

APIの更新手順例:2014-07-272015-11-17

  • API更新に際し、まず加盟店様に付与されたコードを更新します。(チャージ項目の仮売上(Captured)振込済(Paid)に変更)
  • APIの呼び出しと同時にOmise-Version: 2015-11-17ヘッダーをOmiseへ指定すると、新しく付与されたコードでは新規APIがお使い頂けるようになります。
  • 一度アプリケーションをデプロイすると、ダッシュボード上でAPI更新を行えるようになります。更新後は全ての呼び出しで2015-11-17が適用されます。

ヘッダー例:

Omise-Version: 2015-11-17

利用可能なAPIバージョン