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)
Environments
Calls
Report an Igloo
Request
| Item | Details | Remarks |
|---|---|---|
| Call | /cstools/igloo/v1/report | |
| Method | PUT | |
| Content Types | application/json | |
| Body | IglooReport | Object as described below |
IglooReport
| Variable | Type | Example | Description | Remarks |
|---|---|---|---|---|
| layoutId | integer | 123456 | The unique ID of the igloo layout | |
| accountId | String | {f6c2f1ce-0fcc-448b-a229-aaaf82d9c14f} | The igloo owner's SWID | |
| reporterId | String | {781efe90-5699-40f1-accd-8f1fddd4094b} | The reporter's SWID | Optional |
| reasonCode | String | The reason code | Codes are defined below |
Response
| Item | Details | Remarks |
|---|---|---|
| Code | HTTP/200 on success, HTTP/400+ on error | |
| Body | IglooQueuedResponse or ErrorResponse | Objects as described below |
IglooQueuedResponse
| Variable | Type | Example | Description | Remarks |
|---|---|---|---|---|
| success | boolean | true | Indicates success of call | |
| message | String | A developer friendly message in English | Optional | |
| iglooApprovalId | integer | 98765 | The ID of the approval record inserted into the database |
ErrorResponse
| Variable | Type | Example | Description | Remarks |
|---|---|---|---|---|
| success | boolean | false | Indicates success of call | Always false for errors |
| message | String | accountId is required | A developer friendly message in English | Optional |
| code | integer | 1 | The integer code of the error type | See Galaxy API Governance (Error Messaging) for a list of codes |
| name | String | INPUT.BAD_REQUEST | The string name of the error type | See Galaxy API Governance (Error Messaging) for a list of names |
Igloo Report Codes
| Code | Reason | Public Reason | Remarks |
|---|---|---|---|
| LAYOUT.GENERAL | Inappropriate Layout | Inappropriate Layout | |
| LAYOUT.SYMBOL | Layout Includes Inappropriate Iconography | Layout Includes Inappropriate Images | |
| LAYOUT.WORD | Layout Includes Inappropriate Word | Layout Includes Inappropriate Words |
Examples
Request
{
"layoutId": 123456,
"accountId": "{f6c2f1ce-0fcc-448b-a229-aaaf82d9c14f}",
"reporterId": "{781efe90-5699-40f1-accd-8f1fddd4094b}",
"reasonCode": "LAYOUT.SYMBOL"
}
Response - Success
{
"success":true,
"message":null,
"iglooApprovalId":2
}
Response - Error
{
"success":false,
"message":"layoutId should be a positive integer",
"code":1,
"name":"INPUT.BAD_REQUEST"
}
cURL
curl --user username:password --header 'Content-type: application/json' --data '@request.json' --request PUT http://dev05api01.sandbox.clubpenguin.com:8080/cstools/igloo/v1/report