Skip to content

Commit

Permalink
Moji: Update translations
Browse files Browse the repository at this point in the history
  • Loading branch information
boxmoji committed Aug 21, 2024
1 parent 3f0aa9a commit c80b4f3
Show file tree
Hide file tree
Showing 45 changed files with 1,007 additions and 313 deletions.
16 changes: 8 additions & 8 deletions guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ APIのバージョン管理により、Boxは、自社のプラットフォー

<Message type="tip">

今後予定されているAPIの変更について常に最新情報を把握できるように、[変更ログ](https://developer.box.com/changelog/)を注視し、開発者コンソールの \[アプリ情報] セクションで現在のメールアドレスを指定しておいてください
今後予定されているAPIの変更について常に最新情報を把握できるように、[変更ログ](https://developer.box.com/changelog/)を注視し、開発者コンソールの \[アプリ情報] セクションで最新のメールアドレスを指定しておいてください

</Message>

Expand All @@ -41,12 +41,12 @@ Box APIは、URLの`path`と`header`でバージョン管理をサポートし

1. バージョンヘッダーを指定せずに[アップロード](`https://upload.box.com/api/2.0/files/content`)エンドポイントを呼び出すと、URLで定義されている`2.0`バージョンが使用されます。

2. Box APIでは、以下に該当する`Box-Version`ヘッダーを処理します。
2. Box APIでは、以下に該当する`box-version`ヘッダーを処理します。

* `Box-Version: 2025.0`のような有効なバージョン名を含む
* `box-version: 2025.0`のような有効なバージョン名を含む
* `https://api.box.com/2.0/files/:file_id/metadata`に送信される

3. 指定したバージョンが正しい場合は、クライアントにレスポンスが返されます。リクエストで`Box-Version`ヘッダーを指定した場合、レスポンスにはこのヘッダーも含まれます。デフォルトでは、このヘッダーはレスポンスに存在しません。バージョンが正しくない場合は、HTTPコード`400`のエラーがクライアントに返されます。
3. 指定したバージョンが正しい場合は、クライアントにレスポンスが返されます。リクエストで`box-version`ヘッダーを指定した場合、レスポンスにはこのヘッダーも含まれます。デフォルトでは、このヘッダーはレスポンスに存在しません。バージョンが正しくない場合は、HTTPコード`400`のエラーがクライアントに返されます。

APIの動作に大きな変更があると、新しいエンドポイントは新しいURLで公開されます。たとえば、`https://upload.box.com/api/2.0/files/content`では、Boxにファイルをアップロードする際にマルチパートのコンテンツタイプをサポートしています。このAPIの新しいバージョンでこのコンテンツタイプがサポートされなくなると、新しいバージョンは新しいURL`https://upload.box.com/api/3.0/files/content`でリリースされます。

Expand Down Expand Up @@ -78,16 +78,16 @@ Boxは、1年に1回、APIエンドポイントに新しく重大な変更を行

## APIバージョンの呼び出し

Box APIのバージョンは、アプリでリクエストする`Box-Version`ヘッダーで明示的に宣言します。次に例を示します。
Box APIのバージョンは、アプリでリクエストする`box-version`ヘッダーで明示的に宣言します。次に例を示します。

```curl
curl --location 'https://api.box.com/2.0/sign_requests' \
--header 'Box-Version: 2025.0' \
--header 'box-version: 2025.0' \
--header 'Authorization: Bearer …
```

クライアントは、作成されたすべての署名リクエストのリストを取得し、バージョン`2025.0`を要求します。使用可能なAPIにはサポートされているバージョンがいくつかあるため、使用するバージョンを`Box-Version`ヘッダーで指定します。APIのバージョンには、**安定****非推奨****不安定**の3種類があります。
クライアントは、作成されたすべての署名リクエストのリストを取得し、バージョン`2025.0`を要求します。使用可能なAPIにはサポートされているバージョンがいくつかあるため、使用するバージョンを`box-version`ヘッダーで指定します。APIのバージョンには、**安定****非推奨****不安定**の3種類があります。

## バージョン管理のエラー

Expand Down Expand Up @@ -234,7 +234,7 @@ APIに含まれるリソースまたはリソースのプロパティが非推
* 非推奨の動作を伴う呼び出しにより、レスポンスヘッダー`Box-API-Deprecated-Reason`と、詳細を確認するためのリンクが返されます。

```sh
Box-Version: 2023.0
box-version: 2023.0
Deprecation: version="version", date="date"
Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/app-diagnostics-report
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: ''
next_page_id: api-calls/permissions-and-errors/versioning-errors
previous_page_id: api-calls/permissions-and-errors/expiration
source_url: >-
https://github.com/box/developer.box.com/blob/main/content/guides/api-calls/permissions-and-errors/app-diagnostics-report.md
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/common-errors
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/expiration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/expiration
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/app-diagnostics-report
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: true
id: api-calls/permissions-and-errors
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls
parent_id: api-calls
next_page_id: api-calls/permissions-and-errors/scopes
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/rate-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/rate-limits
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/scopes
Expand Down
2 changes: 1 addition & 1 deletion guides/api-calls/permissions-and-errors/scopes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/scopes
type: guide
total_steps: 5
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: api-calls/permissions-and-errors/expiration
Expand Down
78 changes: 78 additions & 0 deletions guides/api-calls/permissions-and-errors/versioning-errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
rank: 100
related_endpoints: []
related_guides: []
required_guides: []
category_id: api-calls
subcategory_id: api-calls/permissions-and-errors
is_index: false
id: api-calls/permissions-and-errors/versioning-errors
type: guide
total_steps: 6
sibling_id: api-calls/permissions-and-errors
parent_id: api-calls/permissions-and-errors
next_page_id: ''
previous_page_id: api-calls/permissions-and-errors/app-diagnostics-report
source_url: >-
https://github.com/box/developer.box.com/blob/main/content/guides/api-calls/permissions-and-errors/versioning-errors.md
fullyTranslated: true
---
# バージョン管理のエラー

Boxでは、特定のAPIエンドポイントに対してバージョン管理機能を提供しています。このバージョン管理システムにより、Boxがエンドポイントのバージョンを新しく導入した場合でも、既存のエンドポイントのバージョンに対してシームレスな機能が保証されます。

APIのバージョン管理により、Boxは、自社のプラットフォームを継続的に強化できると同時に、機能の更新や廃止のための信頼できる手段をサードパーティの開発者に提供することもできます。

APIの変更について常に最新情報を把握できるように、[変更ログ](https://developer.box.com/changelog/)を注視し、開発者コンソールの \[**アプリ情報**] セクションで最新のメールアドレスを指定しておいてください。

## エラーの例

バージョン管理されているAPIコールの使用時に、バージョン管理に関連したエラーが発生する場合があります。このリファレンスでは、エラーが表示される最も一般的なケースを挙げ、そのようなエラーの例を示します。

## 正しくない`box-version`ヘッダーを使用した呼び出し

正しくない`box-version`ヘッダーを使用してAPIを呼び出すと、APIは`HTTP error code 400 - Bad Request`エラーで応答し、レスポンスのメッセージ内にサポート対象のバージョンを示します。

レスポンスの`message`フィールドには、以下のステータスメッセージのいずれかが含まれます。

| 詳細 | メッセージ |
| ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| `box-version`値が、サポートされていないAPIバージョンであるか、正しくない形式で送信されました。 | `Invalid API version specified in 'box-version' header.` |
| バージョン管理されているエンドポイントのみが呼び出されたときに、リクエストヘッダーに`box-version`ヘッダーが含まれていませんでした。 | `Missing required box-version header.` |
| `box-version`が空です。 | `Invalid (empty) API version specified in 'box-version' header.` |
| `box-version`に複数のバージョンが含まれていました。リクエストごとに指定できるバージョンの数は**1つのみ**です。 | `The 'box-version' header supports only one header value per request, do not use comas.` |
| サポートされていないAPIバージョンが既存のエンドポイントに使用されています。 | `Unsupported API version specified in 'box-version' header.` |

`box-version`ヘッダーが正しくない場合のレスポンスの例:

```json
{
"type": "error",
"status": 400,
"code": "invalid_api_version",
"help_url": "https://developer.box.com/reference/error-codes/invalid-api-version",
"message": "Invalid API version specified in 'box-version' header. Supported API versions: [2024.0].",
"request_id": "abcdef123456"
}

```

## URLでの正しくないAPIバージョンの呼び出し

Boxのドキュメントでは、APIのURLが示されています。たとえば、署名リクエストのエンドポイントへのアクセスには`https://api.box.com/2.0/sign_requests/`を使用します。誤って`https://api.box.com/3.0/sign_requests/`のような正しくないバージョンを呼び出すと、レスポンスでは`HTTP error code 404 - Not Found`エラーが返されます。

## 非推奨のAPIの呼び出し

Boxで非推奨としてマークされたAPIバージョンを使用した場合、APIは通常どおり応答します。また、非推奨になった日付を示す`Deprecation`ヘッダーが追加されます。次に例を示します。

```sh
Deprecation: date="Fri, 11 Nov 2023 23:59:59 GMT"
Box-API-Deprecated-Reason: https://developer.box.com/reference/deprecated

```

APIレスポンスを監視して`Deprecation`ヘッダーが存在するかどうかを確認し、その結果に応じて新しいAPIバージョンへの移行を計画する必要があります。

## 存在しないバージョンの呼び出し

公式サポートが終了した古いAPIバージョン (`2023.0`など) を使用しようとすると、レスポンスでは`HTTP error code 404 - Not Found`が返されます。詳細については、[URLでの正しくないAPIバージョンの呼び出し](#calling-an-incorrect-api-version-in-the-url)を参照してください。
2 changes: 1 addition & 1 deletion guides/authentication/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ fullyTranslated: true

新しいトークンの取得はコストが高いため、トークンのキャッシュを使用して、不要なリクエストが行われないようにすることをお勧めします。

トークンは、取得後、Memcachedなどのインメモリキャッシュ、または組み込みのASP.NETキャッシュサービスに保存してください。デフォルトでは、アクセストークンの有効期限は60分ですが、バッファーを確保するために50分程度に設定することをお勧めします
トークンは、取得後、Memcachedなどのインメモリキャッシュ、または組み込みのASP.NETキャッシュサービスに保存してください。デフォルトでは、アクセストークンの有効期限は60分ですが、バッファを確保するために50分程度に設定することをお勧めします

トークンが必要になったら、まずキャッシュに有効なトークンがあるかどうかを確認します。トークンの有効期限が切れている場合は、新しいトークンを取得し、キャッシュに50分間保存します。

Expand Down
2 changes: 2 additions & 0 deletions guides/authentication/client-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ Grant credentials are invalid [400 Bad Request] invalid_grant - Grant credential

</Message>

* アプリケーションがBox管理コンソールで承認されていない

<!-- i18n-enable localize-links -->

[2fa]: https://support.box.com/hc/ja/articles/360043697154-アカウントの多要素認証の設定
Expand Down
2 changes: 1 addition & 1 deletion guides/authentication/jwt/as-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ as-userヘッダーでは[サービスアカウント](page://platform/user-type

</Message>

## SDKを使用したas-user
## as-userを使用できるSDK

すべての[Box公式SDK][sdk]では、`as-user`ヘッダーを使用してユーザーの代わりに処理を実行することがサポートされています。

Expand Down
2 changes: 1 addition & 1 deletion guides/authentication/jwt/without-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ $config = json_decode($json);

</Message>

### 2. 秘密キーを復号する
### 2. 秘密キーを復号化する

JWTアサーションを作成するために、アプリケーションでは構成オブジェクトにある秘密キーが必要になります。この秘密キーは暗号化されており、ロックを解除するにはパスコードが必要です。暗号化されたキーとパスコードは両方とも、構成オブジェクトで指定されています。

Expand Down
2 changes: 1 addition & 1 deletion guides/authentication/oauth2/as-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ curl https://api.box.com/2.0/folders/0 \

さらに、認証済みユーザーは、管理者権限を持つユーザー、つまり、管理者、共同管理者、またはサービスアカウントのいずれかである必要があります。共同管理者にも、「ユーザーを管理する」権限のスコープが必要です。詳細については、[ユーザータイプ](page://platform/user-types)のガイドを参照してください。

## SDKを使用したas-user
## as-userを使用できるSDK

<Tabs>

Expand Down
2 changes: 1 addition & 1 deletion guides/authentication/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ fullyTranslated: true
| Boxアプリケーションの種類 | OAuth 2.0をサポートしますか? | JWTは? | クライアント資格情報は? | アプリトークンは? |
| ----------------------- | ------------------- | ----- | ------------ | --------- |
| [カスタムアプリ][custom-app] | はい | はい | はい | いいえ |
| [アクセス制限付きアプリ][la-app] | いいえ | はい | いいえ | はい |
| [アクセス制限付きアプリ][la-app] | いいえ | いいえ | いいえ | はい |
| [カスタムスキル][custom-skill] | いいえ | いいえ | いいえ | いいえ |

## クライアント側
Expand Down
Loading

0 comments on commit c80b4f3

Please sign in to comment.