Methods & parameters

Contents

1. Create Session
2. Ping
3. Test Session
4. Get Player

Connectivity

Create Session

Request: /createsession[ResponseFormat]/{developerId}/{signature}/{timestamp}

A required step to Authenticate the developerId/signature for further API use.

Response: JSON

{
    "Active_Sessions": 1,
    "Concurrent_Sessions": 50,
    "Request_Limit_Daily": 7500,
    "Session_Cap": 500,
    "Session_Time_Limit": 15,
    "Total_Requests_Today": 9,
    "Total_Sessions_Today": 7,
    "ret_msg": null
}

Ping

Request: /ping[ResponseFormat]

A quick way of validating access to the Hi-Rez API.

Response: TEXT PLAIN

"RealmAPI (ver 1.0.0.0) [PATCH - ] - Ping successful. Server Date:6/28/2018 2:06:40 PM"

Test Session

Request: /testsession[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

A means of validating that a session is established.

Response: TEXT PLAIN

"This was a successful test with the following parameters added: developer: 1004 time: 5/11/2018 11:12:26 AM signature: c332691773af33948c9ddb12e5fb444f session: 1465AFCA32DBDB800CEF8C72F296C52C"

APIs

Get Player

Request: /getPlayer[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}/hirez