Skip to main content
X API は、進化を可能にしつつ安定性を確保するために、エンドポイントのパスにバージョン番号を使用します。このバージョニング戦略を理解することで、連携を計画し、常に最新の状態を維持しやすくなります。

​
現行バージョン

新規プロジェクトには X API v2 を使用してください。新機能はすべてここで提供されます。

​
URL のバージョン

バージョン番号はエンドポイントのパスに含まれます。

​
非互換な変更と互換性を維持する変更

​
破壊的変更 (コードの更新が必要)

これらの変更はメジャーバージョンの更新時にのみ行われます。
  • エンドポイントの削除
  • レスポンスフィールドの削除
  • クエリパラメータの削除
  • 新しい必須パラメータの追加
  • フィールドのデータ型の変更
  • フィールドまたはリソース名の変更
  • レスポンスコードまたはエラー type の変更
  • 認可スコープの変更

​
後方互換性を壊さない変更 (追加的)

これらはバージョンを変更せずにいつでも行われる可能性があります：
  • 新しいエンドポイントの追加
  • 新しいオプションパラメータの追加
  • 新しいレスポンスフィールドの追加
  • 新しい OAuth スコープの追加
  • エラーメッセージの文言の変更
  • プライバシー／セキュリティ上の理由によるフィールドの null 設定

​
リリーススケジュール

​
非推奨ポリシー

新しいメジャーバージョンをリリースする際の流れは次のとおりです。
  1. 非推奨化: 以前のバージョンが非推奨としてマークされます
  2. サポート期間: 非推奨となったバージョンは、定められた期間中は引き続き利用できます
  3. 廃止: 非推奨バージョンは削除されます

​
定義

​
最新情報を入手する

変更に関する通知を受け取るには:

Changelog

プラットフォームに関するすべての変更とアップデート。

フォーラムのお知らせ

後方互換性に影響する変更の通知。

@XDevelopers

プラットフォームのニュースとアップデート。

ニュースレター

月次ダイジェスト。

​
移行リソース

新しいバージョンがリリースされた際には、次の内容を提供します。
  • 移行ガイド: ステップバイステップのアップグレード手順
  • エンドポイント対応表: v1 から v2 への対応関係
  • データ形式の変更点: オブジェクトモデルの違い

移行の概要

最新の移行に関するガイダンスです。

エンドポイント対応表

v1 から v2 へのエンドポイント対応表です。

​
ベストプラクティス

v2 を利用する

新しいプロジェクトは最新バージョンで開始してください。

アナウンスを確認する

変更履歴とフォーラムの更新を購読してください。

変更をテストする

本番環境を更新する前に開発環境でテストしてください。

移行を計画する

非推奨になるまでアップグレードを待たないでください。