【モバイル Synthetic テスト】利用規約の確認¶
POST /api/v1/dialing_task/mobile/terms/accept
概要¶
規約確認用に保持されているエンドポイントです。OpenAPI Key はメンバーによる確認の代わりにはなりません。
呼び出し前の確認と使用手順¶
この公開パスは保持されていますが、コントローラーは実際の Front ログイン状態にあるワークスペース Owner/管理者のみに確認を許可するため、DF-API-KEY で通常どおり呼び出すと 403 ft.MobileDialTermsAcceptForbidden が返されます。Key で確認を成功させることができるパラメータの組み合わせは存在しません。権限を持つメンバーがプロダクト内で内容を確認したうえで、確認状態の照会 により検証してください。
リクエスト例では {} を使用し、acceptedBy/acceptedAt による偽造記録を提供することはできません。この OpenAPI 分岐は権限チェックの箇所で終了するため、確認記録や成功監査は生成されません。共有されている Front の実装では冪等な確認およびサーバー側の時刻/身元の生成が可能ですが、これは現在の Key エントリがその動作をサポートすることを意味するものではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報です。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
パラメータ補足説明¶
確認できるのはログイン状態にあるワークスペース Owner または管理者のみで、API Key は禁止されています。空のリクエスト {} のみを受け付け、バージョン、ユーザー、時刻、ワークスペースのフィールドは受け付けません。成功が重複した場合は、最初のユーザーとサーバーの Unix 秒 acceptedAt が保持されます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/mobile/terms/accept' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{}'
レスポンス¶
通常の OpenAPI 呼び出しでは HTTP 403 の JSON エラーが返されます。以下に実際の拒否構造を示しますが、Key での呼び出しが確認に成功できることを示すものではありません。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | OpenAPI が正常に拒否した場合の空のエラー内容です。この route は declaration をスキップします。 |
{
"code": 403,
"content": {},
"errorCode": "ft.MobileDialTermsAcceptForbidden",
"message": "モバイル Synthetic テストの利用規約を確認できるのは、ログイン状態にあるワークスペース Owner または管理者のみです。",
"success": false,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body のトップレベルが JSON オブジェクトではなく、確認権限チェックより前に失敗 | 一部の json ファイルの形式エラー | 例の {} のとおりに送信してください。有効なオブジェクトであっても、Key が確認権限を得られるわけではありません。 |
| 403 | ft.MobileDialTermsAcceptForbidden | OpenAPI の身元が適格な Front ログイン状態のメンバーではない | モバイル Synthetic テストの利用規約を確認できるのは、ログイン状態にあるワークスペース Owner または管理者のみです。 | プロダクトにログインし、ワークスペース Owner/管理者が内容を確認してください。API Key でメンバーを偽装しないでください。 |