運用制約・バージョン管理

環境とFQDN

テスト環境と本番環境を用意しています。
各環境はFQDN(絶対ドメイン名)で区別され、取引のデータは共用されません。
テスト環境での確認を終えて商用利用を開始する際は、以下の2点を切り替えます。

• HTTPヘッダーの「認証情報」を本番アカウントのものに更新
• 接続先のAPIエンドポイントのFQDNを以下のものに更新

環境	目的	FQDN
テスト環境	APIの接続を確認する	stg.openapi.mul-pay.jp
本番環境	商用の取引を実行する	openapi.mul-pay.jp

同時接続数の制限

全ての加盟店様が安定して当サービスを利用できるよう、APIの同時接続数には上限があります。
同時接続数はショップIDかつAPIエンドポイントごとに管理され、上限値を超えたリクエストはtoo_many_requestsエラーになります。

同時接続数の数え方

以下の期間を接続状態として、接続数1と数えます。

• 開始：加盟店様サーバーからのAPIリクエストが当サービスに到達
• 終了：処理が完了して当サービスからレスポンスを返却

一定時間内のリクエスト数を制限するAPIレート制限とは異なり、当サービス内の処理実行時間によって、1秒あたりにリクエストできる数が変わります。
例えば、同時接続数の上限値が5で、1リクエストの処理実行時間が0.1秒の場合、1秒間に最大50件のリクエストを送信できます。
1リクエストの処理実行時間が5秒の場合は、1～5秒の間は最大5件のリクエストしか送信できません。

同時接続数の上限値

上限値はAPIエンドポイントごとに決められており、各環境での値は以下の通りです。
実際の値はショップ管理画面から確認ができます。

確認方法は912_OpenAPIタイプ管理画面操作マニュアルを参照してください。

APIの分類		エンドポイント	同時接続数の上限値
			本番環境	テスト環境
認証API	アクセストークン	アクセストークン発行（/token）API	5	5
支払いAPI	クレカ払い	都度支払い（/credit/charge）API	5	5
		随時支払い（/credit/on-file/charge）API	5	5
		3Dセキュア後の支払い（/tds2/finalizeCharge）API	5	5
		有効性確認（/credit/verifyCard）API	5	5
		3Dセキュア後の有効性確認（/tds2/finalizeVerification）API	5	5
		カード登録（/credit/storeCard）API	5	5
		カード詳細情報取得（/credit/getCardDetails）API	5	5
	Pay払い	都度支払い（/wallet/charge）API	5	5
		随時支払い（/wallet/on-file/charge）API	5	5
		利用承諾（/wallet/authorizeAccount）API	5	5
		購入者情報取得（/wallet/getCustomerData）API	5	5
	後払い	出荷報告（/deferredpay/shipping）API	5	5
		出荷取消（/deferredpay/shippingCancel）API	5	5
		出荷変更（/deferredpay/shippingUpdate）API	5	5
		取引変更（/deferredpay/orderUpdate）API	5	5
	現金払い	支払い番号発行（/cash/charge）API	5	5
	取引管理	決済確定（/order/capture）API	10	10
		金額変更（/order/update）API	10	10
		キャンセル（/order/cancel）API	10	10
		取引照会（/order/inquiry）API	10	10
	会員管理	ID登録（/member/create）API	5	5
		照会（/member/inquiry）API	5	5
		全削除（/member/delete）API	5	5
		認証情報削除（/member/deleteItem）API	5	5
本人確認API	本人確認	認証開始（/verification/start）API	5	5
		照会（/verification/inquiry）API	5	5

上限値を増やす場合

上記の上限値を超えてリクエストを行いたい場合、営業担当もしくはカスタマーサポートへご連絡ください。
代理店を通した契約の店子様は、代理店へご相談ください。

テスト環境での負荷テスト

テスト環境での負荷テストは実施しないでください。
負荷テストにより当サービスに影響が出た場合、予告なく利用を制限します。

バージョン管理

OpenAPIタイプのAPI仕様は順次アップグレードされ機能が追加されていきますが、加盟店様の稼働中システムに影響を与える破壊的変更は原則行いません。
それでも破壊的変更を伴うアップグレード時は、数ヵ月前に加盟店様にご連絡します。
以下は破壊的変更ではなく、後方互換があるものとして扱われます。

• エンドポイントの追加
• Webhook通知、コールバック時イベントeventの追加
  （加盟店様側で新たなイベントを受け取れるための開発は必要です）
• 設定任意リクエストパラメーターの追加
• レスポンスパラメーターの追加
• 設定任意リクエストHTTPヘッダー項目の追加
• レスポンスHTTPヘッダー項目の追加
• リクエストパラメーターに設定する文字列長・文字種・パターンの追加
• 設定必須リクエストパラメーターを任意へ変更

OpenAPIタイプのAPIリファレンス（OASファイル）とAPI仕様それぞれにバージョンがあります。
API仕様のバージョンはAPIバージョンを参照してください。

種類	形式	表記の例
APIリファレンス（OASファイル）バージョン	セマンティック・バージョニング形式	1.0.1
APIバージョン	YYYY-MM(年月)形式	2023-06

APIリファレンス（OASファイル）バージョン

OpenAPIタイプのAPIリファレンス、およびダウンロード可能なOpenAPI specification（OAS）ファイルのバージョンです。
以下の基準で各バージョンが上がります。

バージョン	基準
メジャー (1番目の数字)	後方互換がない破壊的変更
マイナー (2番目の数字)	仕様追加や変更・削除
パッチ (3番目の数字)	軽微な仕様変更や説明の追加・修正

APIバージョン

当サービスのAPI仕様のバージョン番号です。
後方互換がない破壊的変更を伴うリリース時の年月を新規に割りあてます。
HTTPヘッダーのAPIバージョンを設定することで破壊的変更前の仕様を保証します。
該当しないバージョン番号(年月)が設定されている場合、それより過去で最も近い年月のバージョンで動作します。
APIバージョンは頻繁に上がりませんが、将来の破壊的変更に備えて予めHTTPヘッダーにバージョン番号または加盟店様システム構築時の年月を設定してください。

例：
APIバージョンが2023-06から2024-06にアップグレード
HTTPヘッダーのAPIバージョンに2023-10が設定されている場合は2023-06バージョンで動作
ただし、2023-13のように日付の様式が正しくない場合は最新バージョンで動作

APIバージョン

2023-06 - 2023-05-30

• 初回リリース