Professional Documents
Culture Documents
Word Filter WebAPI-Reference J
Word Filter WebAPI-Reference J
92
Word Filter Web API リファレンス 21
95
09
00
Document serial number: 000009952192
00
SCE CONFIDENTIAL
目次
共通仕様 ................................................................................................................................................. 3
HTTP ステータスコード .................................................................................................................4
エラー ..................................................................................................................................................... 5
Error ................................................................................................................................................6
error .................................................................................................................................................7
エラーコード...................................................................................................................................8
WordFilter API ..................................................................................................................................... 10
POST CensorComment ................................................................................................................ 11
POST SanitizeComment ...............................................................................................................13
92
21
95
09
00
Document serial number: 000009952192
00
©SCEI
-2-
SCE CONFIDENTIAL
92
共通仕様 21
95
09
00
Document serial number: 000009952192
00
©SCEI
-3-
SCE CONFIDENTIAL
HTTP ステータスコード
Word Filter Web API が返す HTTP ステータスコード
定 義
値 メッセージ 説明
200 OK 成功
400 Bad Request リクエストの誤り
401 Unauthorized 認証情報がないなど
403 Forbidden リクエストが拒否された
404 Not Found 指定されたリソースが存在しないなど
429 Too Many Requests 頻度制限を超えた
500 Internal Server Error サーバ内部の予期せぬエラー
92
503 Service Unavailable メンテナンス中、サービスが終了しているなど
解 説
21
95
09
00
Document serial number: 000009952192
00
©SCEI
-4-
SCE CONFIDENTIAL
92
エラー 21
95
09
00
Document serial number: 000009952192
00
©SCEI
-5-
SCE CONFIDENTIAL
Error
エラー発生時のレスポンスボディのルートオブジェクト
定 義
{
"error" : error オブジェクト
}
メ ン バ
error エラーコードと説明を保持するオブジェクト
92
解 説
エラー発生時にレスポンスボディとして返されるルートオブジェクトです。
21
95
09
00
Document serial number: 000009952192
00
©SCEI
-6-
SCE CONFIDENTIAL
error
エラー内容を表すオブジェクト
定 義
{
"code" : Number,
"message" : String
}
メ ン バ
code エラーコード。値の範囲は 2166784-2170879
message
92
英文のデバッグ用エラーメッセージ。ASCII で最大 128 文字
解 説
エラー発生時のエラーコードおよびエラーメッセージを表すオブジェクトです。
21
message に返されるメッセージは開発者向けですので、ユーザーに対して表示しないでください。
code に返されたエラーコードを用いてユーザー向けのエラーメッセージを表示する方法がプロダク
トタイプごとに用意されていますので、「PlayStation™Network Web API 概要」ドキュメントを参照
してください。
95
09
00
Document serial number: 000009952192
00
©SCEI
-7-
SCE CONFIDENTIAL
エラーコード
Word Filter Web API が返すエラーの一覧
定 義
92
2166786 Unsupported API version サポートされていない API バージョン
2166787 Too large body リクエストボディが長すぎる
2166788 Invalid NP environment 環境名が不正
2167040 Invalid query string 詳細は不明だが、クエリストリングの値が不
正
2167041
2167042
Invalid parameter in query
string (parameter:
'parameter_name')
Invalid parameter combination in
query string (parameters:
'parameter1', 'parameter2'…)
21 クエリストリングのクエリパラメータの値が
不正
クエリストリングのクエリパラメータの組み
合わせが不正
95
2167043 Cannot use query string 指定されたリソースに対して利用できないク
('parameter=value') for the エリパラメータが指定された
specified resource
2167044 Invalid parameter in URL URL に含まれるパラメータ部の値が不正
(parameter: 'parameter_name')
'parameter_name' parameter
09
2167045 クエリストリングに必須クエリパラメータが
required in query string 存在しない
2167104 Invalid header (header: リクエストヘッダのヘッダの値が不正
'header_name')
2167105 'header_name' header required リクエストヘッダに必須ヘッダが存在しない
2167168 Invalid body 詳細は不明だが、リクエストボディの値が不
00
正
Null value not allowed
Document serial number: 000009952192
©SCEI
-8-
SCE CONFIDENTIAL
92
2167309 Not authorized access token 正しくない手段で取得したアクセストークン
2167310 Needs to upgrade for PSN access アカウント更新の済んでいないアカウントで
アクセスした
2167424 Unknown client アクセストークンのクライアント ID が不正
備 考
00
本ドキュメントに載っていないエラーコードが返ってきても処理を継続できるようにしておいてくだ
Document serial number: 000009952192
さい。
00
©SCEI
-9-
SCE CONFIDENTIAL
92
WordFilter API 21
95
09
00
Document serial number: 000009952192
00
©SCEI
- 10 -
SCE CONFIDENTIAL
POST CensorComment
不適切な文字列をチェックする
リ ク エ ス ト
URI
POST WordFilterBaseUrl/v1/censorComment
• WordFilterBaseUrl
Word Filter Web API グループのベース URL を指定してください。
クエリパラメータ
92
なし
ヘッダ
Content-Type: application/json; charset=utf-8
Authorization: Bearer AccessToken
• AccessToken
アクセストークンを指定してください。
リクエストボディ
{
21
95
"comment" : String
}
comment チェック対象の UTF-8 文字列。最大 1024 文字
09
レ ス ポ ン ス
正常終了時
HTTP ステータスコードには 200 が、ヘッダの Content-Type には application/json が、レスポ
00
エラー時
すべての API に共通のエラーのいずれか(「エラーコード」節を参照)を表す HTTP ステータスコード
00
およびレスポンスボディが返されます。
解 説
チャットなどの文字列をチェックする必要はありません。全プレイヤーが目にしつつ、長期間にわた
り残るような文字列をチェックしてください。なお、不適切と判断される言葉のルールは予告なく変
更されます。
©SCEI
- 11 -
SCE CONFIDENTIAL
利 用 制 限
プラットフォーム 利用可否
PlayStation®4 アプリケーション 不可
PlayStation®3 アプリケーション 不可
PlayStation®Vita アプリケーション 不可
コンパニオンアプリケーション 可
アプリケーションサーバ / ウェブサイト 不可
使 用 例
リクエスト
92
POST WordFilterBaseUrl/v1/censorComment
{
"comment":"これは不適切な文字列です。"
}
レスポンス
{
}
"result":false 21
95
09
00
Document serial number: 000009952192
00
©SCEI
- 12 -
SCE CONFIDENTIAL
POST SanitizeComment
不適切な文字列を訂正する
リ ク エ ス ト
URI
POST WordFilterBaseUrl/v1/sanitizeComment
• WordFilterBaseUrl
Word Filter Web API グループのベース URL を指定してください。
クエリパラメータ
92
なし
ヘッダ
Content-Type: application/json; charset=utf-8
Authorization: Bearer AccessToken
• AccessToken
アクセストークンを指定してください。
リクエストボディ
{
21
95
"comment" : String
}
comment 訂正対象の UTF-8 文字列。最大 1024 文字
09
レ ス ポ ン ス
正常終了時
HTTP ステータスコードには 200 が、ヘッダの Content-Type には application/json が、レスポ
00
エラー時
すべての API に共通のエラーのいずれか(「エラーコード」節を参照)を表す HTTP ステータスコード
およびレスポンスボディが返されます。
©SCEI
- 13 -
SCE CONFIDENTIAL
解 説
チャットなどの文字列をチェックする必要はありません。全プレイヤーが目にしつつ、長期間にわた
り残るような文字列をチェックしてください。なお、不適切と判断される言葉のルールは予告なく変
更されます。
この API は、与えられた文字列が何語であろうとそのまま(不適切な言葉を伏字にする以外はそのま
ま)返します。Accept-Language ヘッダを指定しても、返される文字列の言語を限定することはでき
ません。
92
利 用 制 限
プラットフォーム 利用可否
PlayStation®4 アプリケーション 不可
PlayStation®3 アプリケーション 不可
PlayStation®Vita アプリケーション
コンパニオンアプリケーション
アプリケーションサーバ / ウェブサイト
リクエスト
09
POST WordFilterBaseUrl/v1/sanitizeComment
{
"comment":"これは不適切な文字列です。"
}
00
レスポンス
{
Document serial number: 000009952192
"result":false,
"sanitizedComment":"これは*******です。"
}
00
©SCEI
- 14 -