gamejolt api

gamejolt api PHP-Bibliothek

https://gamejolt.com

Diese Bibliothek bietet eine vollständige Abdeckung (außer Batchverarbeitung) der API von Game Jolt (Trophäen, Punktestände, Sitzungen usw.). Derzeit wird diese Bibliothek für Version 1.2 der API von Game Jolt geschrieben und getestet.

Installation

$ composer require " harrk/gamejolt-api " 

Verwendung

Erstellen Sie eine Instanz von GamejoltApi und stellen Sie eine GamejoltConfig bereit, um mit der Durchführung von API-Aufrufen an Game Jolt zu beginnen.

 $ gameId = 0 ; // Your game's ID
$ gamePrivaykey = " Your game's private key " ;

$ api = new GamejoltApi ( new GamejoltConfig (
    $ gameId ,
    $ gamePrivaykey
));

Endpunkte

Nachfolgend finden Sie Beispiele dafür, wie Sie mit den einzelnen Endpunkten interagieren würden. Beachten Sie, dass dies nur Beispiele sind und möglicherweise nicht alle Parameteroptionen verwendet werden.

Weitere Optionen finden Sie in der Game Jolt API-Dokumentation oder im Quellcode.

Datenspeicher

Mit der Data Store API können Daten in der Cloud gespeichert/abgerufen werden.

 // Fetch the value for my-key
$ api -> dataStore ()-> fetch ( ' my-key ' );

// Set the value for my-key to my-value
$ api -> dataStore ()-> set ( ' my-key ' , ' my-value ' );

// Update player-logins by 1
$ api -> dataStore ()-> update ( ' player-logins ' , DataStore:: OPERATION_ADD , 1 );

// Remove my-key
$ api -> dataStore ()-> remove ( ' my-key ' );

// Fetch all keys
$ api -> dataStore ()-> getKeys ();

Freunde

Die Freunde-API kann derzeit nur verwendet werden, um die Freunde-IDs des Benutzers zu finden.

 // Fetch all friend ids for the user
$ api -> friends ()-> fetch ( ' username ' , ' user-token ' );

Partituren

 //Fetch scores
$ api -> scores ()-> fetch ();

//Fetch all score tables
$ api -> scores ()-> tables ();

//Add a gamejolt user's score to the table
$ api -> scores ()-> addUserScore ( ' username ' , ' user_token ' , ' 100 Jumps ' , 100 );

//Add a guest's score to the table
$ api -> scores ()-> addGuestScore ( ' Mr Guest ' , ' 50 jumps ' , 50 );

//Get score rank
$ api -> scores ()-> getRank ( 60 );

Sitzungen

 //Open a session for the given user
$ api -> sessions ()-> open ( ' username ' , ' user_token ' );

//Let GJ know the user session is still active
$ api -> sessions ()-> ping ( ' username ' , ' user_token ' , Sessions:: STATUS_ACTIVE );

//Check if the session is still open for user
$ api -> sessions ()-> check ( ' username ' , ' user_token ' );

//Close the session for user
$ api -> sessions ()-> close ( ' username ' , ' user_token ' );

Zeit

 //Get GJ's server time
$ api -> time ()-> fetch ();

Trophäen

 //Get all trophies
$ api -> trophies ()-> fetch ( ' username ' , ' user_token ' );

//User has achieved a trophy with ID 1
$ api -> trophies ()-> addAchieved ( ' username ' , ' user_token ' , 1 );

//User unachieved trophy with ID 1
$ api -> trophies ()-> removeAchieved ( ' username ' , ' user_token ' , 1 );

Benutzer

 //Fetch data on user
$ api -> users ()-> fetch ( ' username ' , ' user_token ' );

//Verify if the user's credentials are correct
$ api -> users ()-> auth ( ' username ' , ' user_token ' );

Ausnahmen abfangen

Hier ist ein Beispiel zum Abfangen von Ausnahmen:

 try {
    $ auth = $ api -> users ()-> auth ( ' username ' , ' user_token ' );
} catch ( TimeOutException $ e ) {
    return redirect ()-> route ( ' home ' )-> with ( ' error ' , $ e -> getMessage ());
}

Testen

Um die Durchführung von Tests zu vereinfachen, wurden zwei Befehle bereitgestellt.

Führen Sie Unit-Tests durch

$ composer test

Führen Sie eine statische Codeanalyse durch

$ composer analyse

Todo

• POST-Methode auf Endpunkten zulassen
• Erhöhen Sie die Abdeckung von Unit-Tests

Lizenz

MIT-Lizenz