Skip to content

Latest commit

 

History

History
201 lines (170 loc) · 6.68 KB

README.md

File metadata and controls

201 lines (170 loc) · 6.68 KB
Raw

api-swgoh-help Maven Central

Java client wrapper for the API at https://api.swgoh.help

Due to the extreme versatility of this API and the available options that are given that modify the response structures, all of the responses returned by each endpoint will be raw JSON in the form of a java.lang.String for now. The consumer of this API client is then free to parse the data into whatever form they choose.

Usage

Include the swgoh-api-connector artifact:

@VERSION@ should be replaced with the version you want to use.

Maven

<dependency>
    <groupId>help.swgoh.api</groupId>
    <artifactId>swgoh-api-connector</artifactId>
    <version>@VERSION@</version>
</dependency>

Gradle

compile 'help.swgoh.api:swgoh-api-connector:@VERSION@'

Examples

In code, use the SwgohAPIBuilder to initialize a new instance of the client:

SwgohAPI api = new SwgohAPIBuilder()
        .withUsername( "username" )
        .withPassword( "password" )
        .build();

Request for a player profile by ally code:

//single player
int allyCode = 123456789;
String player = api.getPlayer( allyCode ).get();
//multiple players
int allyCode = 123456789;
int otherAllyCode = 987654321;
List<Integer> allyCodes = Arrays.asList( allyCode, otherAllyCode );
String players = api.getPlayers( allyCodes ).get();
//only return certain fields in the response
int allyCode = 123456789;
String player = api.getPlayer( 
        allyCode,
        new SwgohAPIFilter( "name", "allyCode", "roster" )
).get();

Request guild info by ally code:

int allyCode = 123456789;
String guild = api.getGuild( allyCode ).get();
//only return certain fields in the response
int allyCode = 123456789;
String guild = api.getGuild( 
        allyCode,
        new SwgohAPIFilter( "name", "gp", "roster", "updated" )
).get();

Request various other kinds of data:

//no filtering, large response
String unitsJson = api.getSupportData( SwgohAPI.Collection.unitsList ).get();
//specify custom filtering criteria for a smaller response
Map<String, Object> matchCriteria = new HashMap<>();
matchCriteria.put( "baseId", "GREEDO" );
matchCriteria.put( "rarity", 7 );
String greedoJson = api.getSupportData( SwgohAPI.Collection.unitsList,
        matchCriteria,
        SwgohAPI.Language.English,
        new SwgohAPIFilter( "nameKey", "combatType", "descKey", "thumbnailName", "baseId" )
).get();

...and so much more! Please reference SwgohAPI.Collection for a list of all available data collections.

Global Discord Registry

(Patreon-tier API accounts only)

This API offers a Discord registry, which is simply a map of ally codes to Discord IDs.

This registry is shared among all Patreon-tier API accounts. If your users have already registered through a different tool that uses this registry, then their registration will already be available to you as well.

Registering an ally code more than once will cause that ally code's association to be overwritten. Registering a Discord ID more than once will cause that Discord ID to be linked to multiple ally codes. This allows users to link their Discord account to all of their game alts, but does not allow a game account to be tied to more than one Discord user at a time.

//create association
int allyCode = 123456789;
String discordId = "098765432123456789";
api.register( allyCode, discordId );
//get association
int allyCode = 123456789;
RegistrationResponse response = api.getRegistrationByAllyCode( allyCode ).get();
//or
String discordId = "098765432123456789";
RegistrationResponse response = api.getRegistrationByDiscordId( discordId ).get();
//remove association
int allyCode = 123456789;
api.unregisterAllyCode( allyCode );
//or
String discordId = "098765432123456789";
api.unregisterDiscordId( discordId );

In order to use this feature, your API account will need to upgrade to Patreon-tier.

You can do this by becoming a Patreon patron and supporting the API in any of the following ways:
API Development
Server Hosting

After becoming a patron, be sure to log into Discord and contact either Midgar777#0394 or shittybill#3024 and give them your API account username so that your account can be given access to this awesome feature.

Asynchronous API with CompletableFuture

Don't want to wait on a response from the API? Set up a callback method using the returned CompletableFuture.

int allyCode = 123456789;
api.getPlayer( allyCode ).thenAccept( player -> {
    //do something with player. This will happen in the future, leaving the main thread unblocked
});

Language Specification

To receive data in a supported language, simply pass the specified language into the overloaded method of your choice.

Example of language-specified result:

String jsonUnitsInKorean = api.getSupportData( SwgohAPI.Collection.unitsList, SwgohAPI.Language.Korean );

Spring Integration

If you'd like to see this work with Spring's dependency injection magic, simply write something similar to the following code:

@Configuration
public class SwgohConfiguration
{
    @Bean
    public SwgohAPI swgohApi()
    {
        return new SwgohAPIBuilder()
                .withUsername( "username" )
                .withPassword( "password" )
                .build();
    }
}

And it's as simple as that. Now you can @Autowire the API client to your heart's content.

@Service
public class SwgohService
{
    @Autowired
    private SwgohAPI swgohApi;
}

Available Language Clients

NodeJS:
https://github.com/r3volved/api-swgoh-help/tree/node

NPM:
https://www.npmjs.com/package/api-swgoh-help

Java:
https://github.com/j0rdanit0/api-swgoh-help

C#:
https://github.com/SdtBarbarossa/SWGOH-Help-Api-C-Sharp https://gist.github.com/dwcullop/9c6b7933fe23163e59b94da1997adee7

PHP:
https://github.com/r3volved/api-swgoh-help/tree/php
https://github.com/rayderua/swhelp-api-client

Google App Script:
https://github.com/Dragonsight91/api-swgoh-help
https://github.com/PopGoesTheWza/swgoh-help-api

Google Sheets:
https://docs.google.com/spreadsheets/d/1lxRBR4d9bWKWGmnhkjYiZ5EMkFogtaCR-qN22D_DGsw/edit?usp=copy

Python:
https://github.com/platzman/swgoh.help.python

Laravel:
https://github.com/matthillman/swgoh-help