gamejolt api

gamejolt api PHP 函式庫

https://gamejolt.com

該庫提供了 Game Jolt API 的完整（批次除外）覆蓋（獎杯、分數、會話等...） 目前該庫是針對 Game Jolt API v1.2 編寫和測試的。

安裝

$ composer require " harrk/gamejolt-api " 

用法

建立 GamejoltApi 的實例並提供 GamejoltConfig 開始對 Game Jolt 進行 API 呼叫。

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

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

端點

以下是如何與每個端點互動的範例。請記住，這些只是範例，可能不會使用所有參數選項。

如需更多選項，請參閱 Game Jolt API 文件或原始碼。

資料儲存

資料儲存 API 可用於在雲端中儲存/檢索資料。

 // 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 ();

朋友們

Friends API目前只能用於尋找使用者的好友ID。

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

分數

 //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 );

會議

 //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 ' );

時間

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

獎盃

 //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 );

使用者

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

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

捕獲異常

以下是如何捕獲異常的範例：

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

測試

提供了兩個命令來簡化測試的運行。

運行單元測試

$ composer test

運行靜態程式碼分析

$ composer analyse

托多

• 允許端點上的 POST 方法
• 增加單元測試的覆蓋範圍

執照

麻省理工學院許可證