オープンベータ版の仕様

本リファレンスに掲載しているAPIエンドポイントは、オープンベータ版として提供する場合があります。これらのエンドポイントには、タイトルや説明に「（β版）」の表記があります。

オープンベータ版APIのご利用にあたっては、通常の一般公開APIとは異なり、以下の制約が適用されます。

1. 破壊的変更（仕様変更）の可能性

ベータ版APIは現在開発中の機能であるため、事前の予告なく後方互換性のない変更（パラメータの削除・変更、レスポンス構造の変更、エンドポイント自体の廃止など）が行われる可能性があります。高い安定性が求められる本番環境でのご利用は推奨いたしません。

2. 今後の展望・正式リリース

オープンベータ版APIでは性質上、破壊的変更に関する個別の事前告知は行われない場合がありますが、「現状の方針」を本ドキュメントまたはアップデート情報にて随時更新・開示いたします。すなわち該当のAPIが今後、安定版に移行する・オープンベータ版を継続する・廃止するなどの現状の方針を明示します。

3. 利用時の必須ヘッダー指定

オープンベータ版のエンドポイントを呼び出す際は、ベータ版の制約とリスクに同意して利用していることを明示するため、リクエストに以下のカスタムヘッダーを含める必要があります。

ヘッダー名: freee-using-beta
値: true

リクエスト例 (cURL):

curl -X GET "https://api.{ドメイン名}/v1/beta-endpoint" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "freee-using-beta: true"

ヘッダー未指定時のエラー

指定のヘッダーが含まれていない場合、APIはリクエストを拒否し、以下のエラーを返します。

エラー構成

{
  "status_code" : 403,
  "errors": [
    {
      "type": "validation",
      "messages": [
        "このエンドポイントの利用には特定のリクエストヘッダーが必要です。リファレンスを参照してください。"
      ]
    }
  ]
}