メインコンテンツまでスキップ

NGWord

ngword.check​

運営ポリシーに反するテキストが含まれるかどうかを確認する為の API です。

API の定義​

REST Base URIhttp://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox )
REST HTTP MethodPOST (オーバーロード POST)
REST URI Fragment/ngword
REST Query ParametersCheck-NGWord-Request-Parameters
Return ObjectNGWord

認可​

typepermissiondescription
ANONYMOUSfalse未認証でのアクセス
SECURITY_TOKENfalseセキュリティトークンを用いた認証
OAUTH_MOBILEfalseモバイル用で発行された OAuth Token を用いた認証
OAUTH_CONSUMERtrueConsumer Request を用いた認証

RESTful API レスポンスコード​

HTTP Status CodeHTTP Status MessageJSON-RPC Error CodesMeaning
200OK–データの取得が成功した場合
400Bad Request-32700, -32600, -32601, -32602, 400クライアント側のリクエストデータが不正です
401Unauthorized401認証エラーです
403Forbidden403リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
404Not Found404存在しないリソースです
405Method Not Allowed405その操作が許可されていない場合です
500Internal Server Error-32603API サーバー側のエラーです
503Service Unavailable–一時的に API が利用不可となっている場合です

JSON-RPC エラーコード​

エラー時の Error オブジェクトの code フィールドに含まれる値です。

RPC CodeMeaning
-32700 (Parse error)不正な JSON format です
-32600 (Invalid Request)不正な JSON-RPC リクエストです
-32601 (Method not found)存在しないメソッドまたは利用不能なメソッドです
-32602 (Invalid params)不正な API リクエストパラメータです
-32603 (Internal server error)API サーバー側のエラーです
400 (Bad Request)他のエラーに該当しないクライアント側の不正なリクエストです
401 (Unauthorized)認証エラーです
403 (Forbidden)リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
404 (Not Found)存在しないリソースです
405 (Method Not Allowed)その操作が許可されていない場合です

データ型​

Check-NGWord-Request-Parameters​

パラメーターは Query String として指定します。

NameTypeDescription
_methodStringRequired, 'check' のみ指定可能

ベースとなるデータ型

  • Standard-Request-Parameters
Starndard-Request-Parameters​

サポートしているフィールド一覧は下記になります。

NameTypeDescription
formatStringOptional 'json' のみ指定可能

詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。

NGWord​

NameTypeDescription
dataString検証する対象の文字列
validBooleanNG ワードチェックに通っているかどうか

サンプルデータ​

RESTful API​

任意のテキスト文に NG ワードが含まれているかどうかを検証する​
POST /social/api/restful/v2/ngword?_method=check
Host: app.sb.mbga-platform.jp

{ "data" : "掲示板等で「殺す」などと言うと投稿が運営側によって削除される場合があります" }

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"valid" : false
}

参考資料​

OpenSocial Core API Server Specification 1.0
OpenSocial Core Data Specification 1.0
OpenSocial Social API Server Specification 1.0
OpenSocial Social Data Specification 1.0

更新履歴​

  • 2010/10/12
    • ngword.check の文言を修正