Home

Getting Started

• Request API access
• Import Dependency
• Usage
• Custom Session Storage

Request API access

To access the APIs you'll need your own set of credentials which consist of a Developer ID (devId) and an Authentication Key (authKey). To getting those credentials, you need filling form on this link: https://fs12.formsite.com/HiRez/form48/secure_index.html

Import Dependency

• Maven
• Gradle
• Gradle (Kotlin DSL)

Maven

<repositories>
    <repository>
        <id>jitpack</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
          <groupId>com.github.stachu540</groupId>
          <!--for all games-->
          <artifactId>HiRezAPI-all</artifactId> 
          <!--for paladins-->
          <!--<artifactId>HiRezAPI-paladins</artifactId>-->
          <!--for smite-->
          <!--<artifactId>HiRezAPI-smite</artifactId>-->
          <!--for realm royale-->
          <!--<artifactId>HiRezAPI-realm</artifactId>-->
          <version>v3</version>
     </dependency>
</dependencies>

Gradle

repositories {
  maven { url "https://jitpack.io" }
}

dependencies {
// for all games
  compile "com.github.stachu540:HiRezAPI-all:v3"
// for paladins
//  compile "com.github.stachu540:HiRezAPI-paladins:v3"
// for smite
//  compile "com.github.stachu540:HiRezAPI-smite:v3"
// for realm royale
//  compile "com.github.stachu540:HiRezAPI-realm:v3"
}

Gradle (Kotlin DSL)

repositories {
  maven("https://jitpack.io")
}

dependencies {
// for all games
  compile("com.github.stachu540:HiRezAPI-all:v3")
// for paladins
//  compile("com.github.stachu540:HiRezAPI-paladins:v3")
// for smite
//  compile("com.github.stachu540:HiRezAPI-smite:v3")
// for realm royale
//  compile("com.github.stachu540:HiRezAPI-realm:v3")
}

Usage

Initialize configuration

Using ConfigBuilder you will initialize into the #initConfig(<config>)

• For Smite is SmiteGame
• For Paladins is Paladins
• For Realm Royale is RealmRoyale

Those classes are have static methods. You don't need initialization into field or variable.

example

RealmRoyale.initConfig {
  setDevId("1004")
  setAuthKey("23DF3C7E9BD14D84BF892AD206B6755C")
  // setUserAgent("User Agent")
  // setSessionStorage(FileSessionStorage("session.txt"))
  // setEndpoint(Realm)
  // setDefaultLanguage(Language.Polish)
}

Custom Session Storage

To Create your own Session Storage use SessionStorage interface