NgWordFilterAPI

1.概要

送られたデータにNGワードが含まれていないかチェックするAPIです。

2.オブジェクトフィールド

2.1 NgWordFilterResult

パラメータ 内容 型
result 審査結果
NGワードが含まれていない場合：OK
NGワードが含まれている場合：NG		 string

3.リクエスト

3.1 エンドポイント

http://gpf-api.[対象ドメイン]/social/ngWord/{data}

3.2 HTTPメソッド

HTTPメソッド 機能
GET 審査結果の取得
PUT –
POST –
DELETE –

3.3 認証

HTTPヘッダーに以下の値を設定してください。全て必須項目です。

キー 値
GAME_CODE 利用ゲームのGAME_CODE
Hash SHA1(GAME_CODE + API_KEY)

3.4 テンプレートパラメータ
data（必須）

パラメータ 内容 備考
{data} 任意の審査対象文 UTF-8を用いて 2回 パーセントエンコーディングで符号化する必要があります。

4.レスポンス

HTTPメソッド レスポンスコード 内容
GET 200 審査正常終了
GET 400 リクエスト不正
GET 401 認証失敗
POST/PUT/DELETE 403 許可されていないメソッド
GET 500 プラットフォームエラー

X.サンプル

X.1 対象文字列にNGワードが含まれていないか、審査する。

リクエスト http://gpf-api.ymdunisys.jp/social/ngWord/%25e6%2596%2587%25e7%25ab%25a0
レスポンスコード 200
レスポンスボディ {“result”:”OK”}
備考 data内にNGワードが含まれている場合、resultはNGになります。