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 설명서 또는 소스 코드를 참조하세요.

데이터 저장소

Data Store 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 메서드 허용
• 단위 테스트 범위 확대

특허

MIT 라이센스