Skip to content

Commit 5e304bb

Browse files
author
Damian Staszewski
committed
Release preparation. v1.0 Is HERE!!!
1 parent 9587ec5 commit 5e304bb

File tree

2 files changed

+59
-1
lines changed

2 files changed

+59
-1
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,61 @@ All features will be on [Projects](https://github.com/stachu540/HiRezAPI/project
1010
* [Core of Script](https://github.com/stachu540/HiRezAPI/projects/3)
1111
* [Smite API](https://github.com/stachu540/HiRezAPI/projects/1)
1212
* [Paladins API](https://github.com/stachu540/HiRezAPI/projects/2)
13+
14+
## Usage
15+
16+
1. 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:
17+
https://fs12.formsite.com/HiRez/form48/secure_index.html
18+
19+
2. For next step. Add dependency to `pom.xml` build.
20+
```xml
21+
<dependency>
22+
<groupId>pl.stachuofficial</groupId>
23+
<artifactId>HiRezAPI</artifactId>
24+
<version>1.0</version>
25+
</dependency>
26+
```
27+
28+
3. To starting using script try to using example below:
29+
30+
For examples I will use example credentials
31+
**DevId**: 1004
32+
**AuthKey**: 23DF3C7E9BD14D84BF892AD206B6755C
33+
34+
a. For Smite **PC** i want getting player info for "HiRezTina"
35+
```java
36+
package example;
37+
38+
import pl.stachuofficial.HiRezAPI; // Main class
39+
import pl.stachuofficial.hirezstudios.Smite; // for importing enum platforms
40+
import pl.stachuofficial.util.StringData; // for using variable data
41+
42+
class SmitePlayer {
43+
public static void main(String[] args) {
44+
HiRezAPI api = new HiRezAPI("1004", "23DF3C7E9BD14D84BF892AD206B6755C");
45+
StringData mydata = api.smite(Smite.Platform.PC).getPlayer("HiRezTina");
46+
// cause data returning as JSONArray i will use toJsonArray() method
47+
System.out.println(mydata.toJsonArray());
48+
}
49+
}
50+
```
51+
b. For Paladins **XBOX** i want know about server status.
52+
```java
53+
package example;
54+
55+
import pl.stachuofficial.HiRezAPI; // Main class
56+
import pl.stachuofficial.hirezstudios.Paladins; // for importing enum platforms
57+
import pl.stachuofficial.util.StringData; // for using variable data
58+
59+
class PaladinsStatusServer {
60+
public static void main(String[] args) {
61+
HiRezAPI api = new HiRezAPI("1004", "23DF3C7E9BD14D84BF892AD206B6755C");
62+
StringData mydata = api.paladins(Paladins.Platform.XBOX).getServerStatus();
63+
// cause data returning as JSONArray i will use toJsonArray() method
64+
System.out.println(mydata.toJsonArray());
65+
}
66+
}
67+
```
68+
69+
## Question and suggestions
70+
Any more questions or some suggestions changes are welcome. Don't be shy, just open your [Issues](https://github.com/stachu540/HiRezAPI/issues) if you have some problem. [Pull Request's](https://github.com/stachu540/HiRezAPI/pulls) and any other contribution are welcome.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>pl.stachuofficial</groupId>
88
<artifactId>HiRezAPI</artifactId>
9-
<version>0.8.0-SNAPSHOT</version>
9+
<version>1.0</version>
1010
<packaging>jar</packaging>
1111

1212
<name>Hi-Rez API</name>

0 commit comments

Comments
 (0)