Profanity
概要
检查指定的文本中是否含有不当词汇。
请务必用于带有用户文本发帖功能的位置。请勿在应用软件上显示ProfanityAPI判为不当的发帖。
注意
与Textdata API 不同,此为机械性检查是否含有不当词汇的功能。公司自行监控时,必须使用Profanity API。
另外,Textdata API 中已带有 Profanity API 的机械性检查是否含有不当词汇的功能,因此如果使用Textdata API ,那么就无需使用Profanity API。
API请求
端点 URL
Sandbox 环境
https://sb-app.mobage.jp/social/api/restful/v2/profanity
正式环境
https://app.mobage.jp/social/api/restful/v2/profanity
HTTP 方法
- Authorization Code Grant
- GET - 输入文本的检查
- Client Credentials Grant
- GET - 输入文本的检查
请求报头
- Authorization 报头为必须。
URL 查询参数
| 参数名 | 类型 | 说明 | 必须 |
|---|---|---|---|
| text | 字符串 | 用户发帖的自由文本 | Yes |
| format | 字符串 | 请指定"json" | No |
请求正文
无
响应代码
| 请求 HTTP 方法 | 响应代码 | 响应信息 | 说明 |
|---|---|---|---|
| GET | 200 | OK | 获取数据成功时 |
| GET | 400 | Bad Request | 客户端的请求数据不当 |
| GET | 401 | Unauthorized | 认证错误 |
| GET | 403 | Forbidden | 资源存在,但由于认证错误以外的原因导致不能访问的情况 |
| GET | 500 | Internal Server Error | API 服务器端错误 |
| GET | 503 | Service Unavailable | API 暂时不可用的情况 |
响应正文
- 输入文本中如有不当词汇,则为 false,如无,则为 true。
- Content-Type: application/json; charset=utf-8
实例
信息
以下输入文本有“杀”之类的不当词汇。因包含在请求中,所以进行了URLEncode。
Base String
GET&http%3A%2F%2Fsb.sp.mbga-platform.jp%2Fsocial%2Fapi%2Frestful%2Fv2%2Fprofanity&oauth_consumer_key%3Dc8bb6e04c60b9f6c0063%26oauth_nonce%3D0db64ddcb4c16ed78d1fd73e5dbbfa8e%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D1381219850%26oauth_token%3Dsp_client_id%253A8a714e962e6620b830ac66ba628f890f%26oauth_version%3D2.0%26text%3D%25E6%25AE%25BA%25E3%2581%2599%25E3%2581%25AE%25E3%2582%2588%25E3%2581%2586%25E3%2581%25AA%25E3%2582%258F%25E3%2582%258B%25E3%2581%2584%25E8%25A8%2580%25E8%2591%2589 |
HTTP 请求
GET /social/api/restful/v2/profanity?text=%E6%AE%BA%E3%81%99%E3%81%AE%E3%82%88%E3%81%86%E3%81%AA%E3%82%8F%E3%82%8B%E3%81%84%E8%A8%80%E8%91%89 HTTP/1.1 Host: sb.sp.mbga-platform.jp Accept: */* Accept-Encoding: gzip Authorization: OAuth oauth_version="2.0",oauth_nonce="0db64ddcb4c16ed78d1fd73e5dbbfa8e",oauth_timestamp="1381219850",oauth_consumer_key="c8bb6e04c60b9f6c0063",oauth_token="sp_client_id%3A8a714e962e6620b830ac66ba628f890f",oauth_signature_method="HMAC-SHA1",oauth_signature="ROYaykoQYlV2SBdMBPUbxKIcYaU%3D" |
HTTP 响应
HTTP/1.0 200 OK Content-Type: application/json; charset=utf-8 Content-Length: 15 Connection: close Date: Tue, 08 Oct 2013 08:10:51 GMT Server: Unknown {"valid":false} |