SMITE API / Paladins /Realm API Developer Guide

TABLE OF CONTENTS

TABLE OF CONTENTS

DOCUMENT CHANGE HISTORY

GETTING STARTED

Introduction

APIs - SMITE Data

API Parameter Details

CREATING A SESSION

CREATING A SIGNATURE

Sample C# Code to Create a Signature:

EXAMPLE API CALL

The MatchId Parameter

GRAPHICS

APPENDIX A - COMPREHENSIVE CODE EXAMPLE

The Form1.Designer.cs file (for the buttons):

DOCUMENT CHANGE HISTORY

DATE

MODIFIED BY

CHANGE DESCRIPTION

GETTING STARTED

The purpose of this document is to provide SMITE API Developers and PALADINS API

Developers with the necessary information to access and utilize the API methods. The

JSON data returned from the API methods is designed to be “self-documenting” and

Credentials

To access the APIs you'll need your own set of credentials which consist of a developer id

(devId) and an authentication key (authKey). The process of obtaining credentials should

be a one-time activity.

Here are the credentials for a sample account:

● DevId: (eg, 1004)

● AuthKey: (eg, 23DF3C7E9BD14D84BF892AD206B6755C)

combination should work for both SmiteAPI and PaladinsAPI, across all supported

To begin using the API, you will first need to establish a valid Session. To do so you will

start a session (via the createsession method) and receive a SessionId. Sessions are

used for authentication, security, monitoring, and throttling. Once you obtain a SessionId,

you will pass it to other methods for authentication. Each session only lasts for 15 minutes

and must be recreated afterward.

More details regarding Session creation are provided later in this document.

API Access Limits

sessions_per_day: 500

session_time_limit: 15 minutes

request_day_limit: 7500

Platform Endpoint Base URLs

As of version 2.11, the SmiteAPI and Paladins API supports 3 platforms: PC, Xbox & PS4. Each

platform is supported by a separate endpoint. Applications access each endpoint via a unique base

URL:

The interface for each endpoint is identical. Therefore, a single application code-base should be able to

support all supported platforms.

However, since each endpoint is serviced by a unique Web Service, applications must create and

maintain separate Sessions for each endpoint. In other words, you cannot use a Session ID created by

the SmiteAPI for PC endpoint (via the /createsession method) to make method calls to the SmiteAPI for

Xbox endpoint.

response.

As stated earlier, the SmiteAPI for Xbox endpoint supports the same API interface as does SmiteAPI

results will return Xbox Live Gamertag as "playername", as is expected in SmiteAPI for PC.

2. Xbox Live Gamertags are owned and administered by Microsoft, outside the purview of Hirez

Studios. We cache current player GamerTag each time a player logs into SMITE for Xbox and

invalidate any other players that might have the same cached GamerTag. In this way, we hope

especially if said player does not log into SMITE for Xbox often. By the same token, if an

abandoned GamerTag is transferred to another Xbox Live player, it is possible that a SmiteAPI

query could return data for the wrong player. Hopefully, this is not a common occurrence, but

we wanted to notify you of the possibility. Note that SMITE playerId is guaranteed unique.

Therefore, if your application already stores SMITE playerId of customers and specifies that

value instead of GamerTag, you eliminate the possibility of name collisions.

3. Caching of GamerTags has only been implemented fairly recently. Therefore, searches of

players by GamerTag who have not logged into SMITE for Xbox since caching was

implemented will obviously fail.

SMITE version 2.14 has introduced the option of player opt-in privacy. Players choosing to enable

privacy for their account will affect data returned by SmiteAPI for said players:

1. Player queries on individual players marked “Private” will fail. In particular, query methods

should return empty dataset, just as if the player did not exist. For example, a /getfriends call on

the player “JohnDoe” would return an empty dataset if JohnDoe was marked Private.

2. Methods that return data on multiple players may still return some data for Private players, while

other data is obfuscated. In particular, for private players:

As an example for item #2 above, the /getmatchdetails method for a specified MatchId would return an

object for each player in the Match. However, the returned object for each Private player would include

API METHODS & PARAMETERS

GRAPHICS

You can find any graphics that we’ve published for use here.

APPENDIX A - COMPREHENSIVE CODE EXAMPLE

To assist with development & debugging efforts, the following sample Microsoft Visual Studio 2012

WindowsFormApplication is provided. Note that you may have to add a few Assembly References to

a.) a button to call the createsession API method, and

b.) a button to call the getgods API method and some logic to display all gods in a MessageBox.

The values for devKey and authKey are removed for security purposes.

Note that the API calls are synchronous and may take a few seconds before generating a response.

You will probably call the API asynchronously, but for purposes of this exercise (to quickly understand

how to work with the API methods) the synchronous method was used.

The application consists of two primary forms (Form1.cs & Form1.Designer.cs) listed on the following

pages.

The Form1.Designer.cs

file (for the buttons):

{

{

/// <summary>

/// Required designer variable.

/// Clean up any resources being used.

{

base.Dispose(disposing);

}

/// <summary>

/// Required method for Designer support - do not modify

/// the contents of this method with the code editor.

this.buttonCreateSession = new System.Windows.Forms.Button();

this.buttonGetGods = new System.Windows.Forms.Button();

this.label2 = new System.Windows.Forms.Label();

this.SuspendLayout();

//

// buttonCreateSession

//

this.buttonCreateSession.Size = new System.Drawing.Size(205, 23);

this.buttonCreateSession.Click += new System.EventHandler(this.buttonCreateSession_Click);

this.buttonGetGods.Location = new System.Drawing.Point(280, 211);

this.buttonGetGods.Name = "buttonGetGods";

this.buttonGetGods.Size = new System.Drawing.Size(205, 23);

this.buttonGetGods.TabIndex = 2;

//

// label1

//

this.label1.AutoSize = true;

this.label1.Name = "label1";

this.label1.Size = new System.Drawing.Size(38, 13);

this.label1.Text = "Step 1";

//

// label2

this.label2.AutoSize = true;

this.label2.Location = new System.Drawing.Point(229, 216);

this.label2.Size = new System.Drawing.Size(38, 13);

this.label2.TabIndex = 5;

// Form1

//

this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);

this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;

this.ClientSize = new System.Drawing.Size(802, 414);

this.Controls.Add(this.label2);

this.Controls.Add(this.buttonGetGods);

this.Controls.Add(this.buttonCreateSession);

this.PerformLayout();

#endregion

private System.Windows.Forms.Label label1;

private System.Windows.Forms.Label label2;

}

}

The Form1.cs

File (For the API Method Calls)

using System.Collections.Generic;

using System.Data;

using System.Drawing;

using System.Linq;

using System.Runtime.Serialization.Json;

public partial class Form1 : Form

{

string authKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; // authKey goes here

string timestamp = DateTime.UtcNow.ToString("yyyyMMddHHmmss");

string urlPrefix = "http://api.smitegame.com/smiteapi.svc/";

public Form1()

InitializeComponent();

}

private static string GetMD5Hash(string input)

{

bytes = md5.ComputeHash(bytes);

sb.Append(b.ToString("x2").ToLower());

private void buttonCreateSession_Click(object sender, EventArgs e)

{

// Get Signature that is specific to "createsession"

// Call the "createsession" API method & wait for synchronous response

//

WebRequest request = WebRequest.Create(urlPrefix + "createsessionjson/" + devKey + "/" + signature + "/" + timestamp);

WebResponse response = request.GetResponse();

Stream dataStream = response.GetResponseStream();

StreamReader reader = new StreamReader(dataStream);

string responseFromServer = reader.ReadToEnd();

reader.Close();

// Parse returned JSON into "session" data

using (var web = new WebClient())

{

var jss = new JavaScriptSerializer();

var g = jss.Deserialize<SessionInfo>(jsonString);

session = g.session_id;

MessageBox.Show(session);

}

//

// Call the "getgods" API method & wait for synchronous response

WebRequest request = WebRequest.Create(urlPrefix + "getgodsjson/" + devKey + "/" + signature + "/" + session + "/" + timestamp + "/"

+ languageCode);

WebResponse response = request.GetResponse();

StreamReader reader = new StreamReader(dataStream);

//

var jss = new JavaScriptSerializer();

var GodsList = jss.Deserialize<List<Gods>>(jsonString);

string GodsListStr = "";

GodsListStr = GodsListStr + ", " + x.Name;

}

}

public class SessionInfo

{

public string session_id { get; set; }

public string timestamp { get; set; }

public class Menuitem

{

public string description { get; set; }

public string value { get; set; }

}

public class Rankitem

{

public string secondaryDescription { get; set; }

public string cost { get; set; }

}

public class AbilityRoot

public AbilityDescription itemDescription { get; set; }

}

public int abilityId4 { get; set; }

public AbilityRoot abilityDescription4 { get; set; }

public AbilityRoot abilityDescription5 { get; set; }

public int id { get; set; }

public string Pros { get; set; }

public string Roles { get; set; }

public string Name { get; set; }

public string OnFreeRotation { get; set; }

public string Lore { get; set; }

public int Health { get; set; }

public Double Speed { get; set; }

public Double HealthPerFive { get; set; }

public Double Mana { get; set; }

public Double ManaPerLevel { get; set; }

public Double PhysicalProtection { get; set; }

public Double PhysicalProtectionPerLevel { get; set; }

public Double MagicProtection { get; set; }

public Double MagicProtectionPerLevel { get; set; }

public Double PhysicalPower { get; set; }

public Double PhysicalPowerPerLevel { get; set; }

public Double AttackSpeedPerLevel { get; set; }

public string Pantheon { get; set; }

public string Ability4 { get; set; }

public string Item3 { get; set; }

public string Item7 { get; set; }

public string Item8 { get; set; }

public string Item9 { get; set; }

public int ItemId1 { get; set; }

public int ItemId3 { get; set; }

public int ItemId4 { get; set; }

}