コンテンツにスキップ
Docs
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

バージョン

外部 API のバージョンの表し方、バージョンを上げる変更、互換性の方針。

外部 API のバージョンはパスで表します。現在のバージョンは v1 で、すべての API のパスは /external/v1 から始まります。サンドボックスも同じパスを使います。

現在のバージョン

  • 本番の API のベース URL は https://api.cozeni.net/external/v1 です。
  • サンドボックスのベース URL は https://api-sandbox.cozeni.net/external/v1 です。
  • GET /account の応答の api_version は "v1" です。
  • OpenAPI の仕様は認証なしで取得できます。本番は https://api.cozeni.net/external/v1/openapi.json、サンドボックスは https://api-sandbox.cozeni.net/external/v1/openapi.json です。

互換とみなす変更

次の変更は同じバージョンの中で行われることがあります。

  • 応答にフィールドが増える。

応答の中の知らないフィールドは無視してください。

バージョンを上げる変更

Cozeni は次の変更を次の API バージョンで行います。

  • 既存のフィールドを削除する。
  • フィールドの型や意味を変える。
  • 認証の方法を変える。

SDK のバージョン

SDK(@nulogic/cozeni-sdk)のバージョンと、API のバージョンは別々に管理されています。SDK はバージョンを固定(SemVer で指定)して導入してください。バージョンを上げるときは、変更の内容を確かめてから上げてください。

次に読むページ

このページは役に立ちましたか?