Skip to content

Methods & parameters

Luís Gustavo edited this page Jun 28, 2018 · 112 revisions

THIS DOCUMENATION WILL CONSUME A JSON RESPONSE.

Contents

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

Connectivity

Create Session

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

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

Request: http://api.realmroyale.com/realmapi.svc/createsessionJson/1004/c332691773af33948c9ddb12e5fb444f/20180628012612

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

/ping[ResponseFormat]

A quick way of validating access to the Realm Royale API.

Request: http://api.realmroyale.com/realmapi.svc/pingjson

Response: TEXT PLAIN

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

Test Session

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

A means of validating that a session is established.

Request: http://api.realmroyale.com/realmapi.svc/testsessionjson/1004/c332691773af33948c9ddb12e5fb444f/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612

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

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