ANGEL CITY INTERACTIVE

Size: px

Start display at page:

Download "ANGEL CITY INTERACTIVE"

Aron Simon
5 years ago
Views:

1 ANGEL CITY INTERACTIVE Security API Guide Version September 2017 Angel City Interactive th St., Apt aidan@aidanatwork.com -

2 Preface Intended Audience This guide is intended for engineers at Angel City Interactive for development of applications using our internal Security API. Readers should have experience with software development and the use of RESTful APIs. Style Conventions The following style conventions are used in this document: Bold Names of requests. Courier Request URLs and response JSON objects. User input variables < > Angle brackets enclose parameter values supplied by the user 2 P age

3 Table of Contents 1. Overview Protocol HTTP Methods URL Format Query Parameters Status Codes Real User Score Request Request Response Samples Benign User Score Request Request Response Samples P age

4 1. Overview The Security API documented in this guide is a RESTful API that you can use to retrieve intelligence about a prospective user trying to create an account or otherwise interact with your application. It returns confidence scores, which you can then use to determine whether to let that user proceed, send that user a warning message, or deny them access to the application altogether Protocol All Security API access is over HTTP. We never use HTTPS for these calls HTTP Methods The Security API supports only the GET HTTP method URL Format The Security API URL uses the following format: Example: GET realuser?ipaddr= P age

5 5 P age

6 1.4. Query Parameters The table below describes the parameters you can pass in your query string for each request. Parameter Meaning Note ipaddr The IP address of the device REQUIRED devid latit longit OSType An ID specific to the device used (ios IDFA, etc.) The latitude of the device s location (positive or negative decimal number) The longitude of the device s location (positive or negative decimal number) The OS of the device (Android, iphone, Blackberry, etc.) 1.5. Status Codes The API uses the following HTTP status codes: Status Code Description 200 OK 400 Bad Request (this usually occurs because the parameter ipaddr was not included) 403 Forbidden 404 Resource Not Found 405 Method Not Allowed 413 Request Entity Too Large 500 Internal Server Error 503 Service Unavailable 6 P age

7 2. Real User Score Request This request returns a score indicating our confidence that the provided data corresponds to a real person, rather than a bot. You can then add logic to your application denying the creation of a new account if the score fails to meet a certain threshold Request The payload will not be used and can be left empty. The HTTP method and URL are as follows: Method URL GET Response If unsuccessful, this method returns a response body containing an empty string. If successful, this method returns a response body containing a JSON object with the following structure: { "ip": string, "realscore": byte } Name Type Description ip string The IP address of the user being scored. realscore byte A number from 1-5 indicating our confidence that the user is a real user: 1 = Least confidence. Very likely a bot. 2 = Less confidence. Most likely a bot. 3 = Medium confidence. We can t determine which is more likely. 4= More confidence. Most likely a real user. 5= Most confidence. Very likely a real user. 7 P age

8 2.1. Samples Below are some sample requests and responses for the Real User Score Request Sample Request GET ipaddr= &devid=d0d668c6185e3d689ef6dc84ca89baf11cc092e 8&latit= &longit= &OSType=ios Sample Response { "ip": " ", "realscore": 2 } 8 P age

9 3. Benign User Score Request This request returns a score indicating our confidence that the user is a benign user, as opposed to one likely to engage in malicious activity. You can then add logic to your application denying the creation of a new account if the score fails to meet a certain threshold Request The payload will not be used and can be left empty. The HTTP method and URL are as follows: Method URL GET Response If unsuccessful, this method returns a response body containing an empty string. If successful, this method returns a response body containing a JSON object with the following structure: { "ip": string, "benignscore": byte } Name Type Description ip string The IP address of the user being scored. benignscore byte A number from 1-5 indicating our confidence that the user is a benign user: 1 = Least confidence. Very likely a malicious user. 2 = Less confidence. Most likely a malicious user. 3 = Medium confidence. We can t determine which is more likely. 4= More confidence. Most likely a benign user. 9 P age

10 5= Most confidence. Very likely a benign user Samples Below are some sample requests and responses for the Benign User Request Sample Request GET ipaddr= &devid=d0d668c6185e3d689ef6dc84ca89baf11cc092e 8&latit= &longit= &OSType=ios Sample Response { "ip": " ", "benignscore": 5 } 10 P age

11 11 P age

EMC Secure Remote Support Device Client for Symmetrix Release 2.00

EMC Secure Remote Support Device Client for Symmetrix Release 2.00 Support Document P/N 300-012-112 REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com Copyright