コンテンツにスキップ
ShopentlyLearn

バージョンと OpenAPI

明示的な /api/v1 契約とダウンロード可能な OpenAPI 文書に基づいて実装します。

API バージョン

API バージョン
URL のバージョンは公開 API の契約を表します。
Engine リリース
OpenAPI 内の Engine リリース番号は、文書を書き出した実装を示します。 リソースの expected_version ではありません。
リソースのバージョン
業務リソースのバージョンは同時更新制御の値として扱い、最新のレスポンスから取得してください。

OpenAPI

OpenAPI をダウンロード
  • ダウンロードした契約を連携のテストと一緒に保存してください。
  • 連携を更新するときは必須フィールド、許可された列挙値、レスポンススキーマを確認します。