Moderation Reports v2
The second iteration of the moderation reports has been migrated from a php base and moved to Java Spring. This will allow us to better support a restful submission service with rapid iteration.
Authentication
Cellophane
Axis APIs are made available to third parties are authenticated using DI Auth, and require an approved client
To request access to Axis APIs, please email #DI DL-AxisTech with the following details
- The environment you wish to access (eg: integration, production)
- The APIs you want to access (eg: /report/v2/queue)
- Where you wish to access the APIs from (eg: DGN, Public Internet)
- Static IP address range requests will come from.
- Your DI Auth client name (eg: DI Axis Gx Tools - Dev)
Please note - we do not require your DI Auth secret. Please do not send this in any communications as this poses a security risk.
To add authentication your requests, please add an Authorization header with the following format (full details on the DI Auth page)
Authorization: GAE <Client Secret>
HTTP Basic Authentication (Deprecated)
Public API
The public API endpoints (eg: https://api.disney.com/) require the guest's AuthZ token in addition to the Cellophane credentials. This is so that we can ensure that we can perform validation on the report submitter. As such, when using public endpoints, the AuthZ Bearer token must be appended to the Authorization header
Authorization: FD <Client UUID>:<Client Secret>, Bearer <AuthZ Token>
Environments
Private
Public
Calls
Submit Report
Request
Item | Description | |
|---|---|---|
| Call | report/v2/queue | The call made to the service ie: {environment}/gxtools/report/v2/queue |
| Method | POST | |
| Headers | Content-Type: application/json | The API will consume an object that has been json encoded. |
| Body | NewReport | Object described below. |
Note: PUT report/v1/report exists as an alias to this end point
NewReport
| Variable | Type | Example | Description |
|---|---|---|---|
| reporter | String | {cf81389b-bdba-4050-84d4-3a480bd60b8a} | The player swid that is reporting a player. |
| reported | String | {cf81389b-bdba-4050-84d4-3a480bd60b8a} | The player that is being reported. |
| location | String | urn:gid:CLP | The location of the incident/chat - this value needs to be the same as the value passed into the Chat Logger system |
| room | String | urn:jid:igloo777@com.disney | The ingame/chat room that the incident occured - this value needs to be the same as the value passed into the Chat Logger system |
| timestamp | Integer | 1338508800 | The unix timestamp gmt of when the incident occured. (seconds) |
| reasonId | Integer | 10 | The reason ID, 1-10, listed below. Deprecated, use reasonCode instead. |
| reasonCode | String | CHAT.BULLYING | The reason code, listed below. Replaces reasonId, taking precedence if both passed. |
| language | String | en | The language that the report is to be handled in. |
| product | String | clubpenguin | The product that the report is being submitted for. |
Raw Body:
{
"reporter": "{cf81389b-bdba-4050-84d4-3a480bd60b8a}",
"reported": "{cf81389b-bdba-4050-84d4-3a480bd60b8a}",
"location": "urn:gid:CLP",
"room": "urn:jid:igloo777@com.disney",
"timestamp": 1338508800,
"reasonId": 10,
"language": "en",
"product": "clubpenguin"
}
Response
Raw Response: {"success":true,"message":"Successfully added the moderation report to the system.","reportId":53}
Detailed Response:
| Variable | Type | Example | Description |
|---|---|---|---|
| success | Boolean | true | The success of the call |
| message | String | Successfully added the moderation report to the system | Message generated from the call |
| reportId | Integer | 53 | The id of the report that was generated. |
Ban Reasons
| Reason Id | Code | Reason | Public Reason |
|---|---|---|---|
| 1 | HACK.COLOR_ITEM | Hacking Color Item | Attempted Game Manipulation |
| 2 | HACK.BACKGROUND | Hacking Background Photo | Attempted Game Manipulation |
| 3 | HACK.HONEY_POT | Hacking Honey Pot | Attempted Game Manipulation |
| 4 | HACK.RINGLEADER | Hacking (ringleader) | Attempted Game Manipulation |
| 5 | CHAT.SWEARING | Swearing | Swearing |
| 6 | CHAT.BULLYING | Bullying or Being Mean | Bullying or Being Mean |
| 7 | CHAT.DISCLOSING_PII | Disclosing Personal Info | Attempted to Reveal Personal Information |
| 8 | CHAT.INAPPROPRIATE | Inappropriate Talk | Inappropriate Talk |
| 9 | CHAT.NA | N/A | Inappropriate Talk |
| 10 | CHAT.REQUESTING_PII | Asking for Personal Info | Attempted to Obtain Personal Information |
| 11 | PLAYER.BAD_NAME | Bad Name | Inappropriate Penguin Name |
| 12 | PLAYER.BAD_IGLOO | Bad Igloo | Inappropriate Igloo Furniture Layout |
| 13 | PLAYER.BAN_LIMIT | Over Ban Limit | Over Ban Limit |
| 14 | CHAT.AUTOBANNABLE_WORD | Autobannable Word | Banned Automatically for swearing or inappropriate talk |
| 15 | PLAYER.IN_GAME_BAN | In-Game Ban | Inappropriate Talk |
| 16 | HACK.ITEM_LAYERS | Hacking Item Layers | Attempted Game Manipulation |
| 17 | HACK.MAIL | Hacking mail | Sent spam |
| 19 | HACK.BOT | Bot | Attempted Game Manipulation |
| 20 | FINANCE.UNAUTH_PURCHASE | Unauthorized Purchases | Unauthorized Purchases |
| 22 | HACK.COINS | Hacking Coins | Attempted Game Manipulation |
| 23 | MISC.SENTINEL | Sentinel DB Match | Sentinel DB Match |
| 24 | CHAT.EMBEDDED_MEDIA | Image/Video | Inappropriate Embedded Image/video |
| 25 | LEGAL.INVESTIGATION | Legal Investigation | Legal Investigation |
Supported Product
The product passed into the API is lower case single string with no spaces. (please try to keep this list in order)
| Product | Acceptable Input |
|---|---|
| Club Penguin | clubpenguin |
| Infinity Online | infinityonline |