gamejolt api

Biblioteca PHP gamejolt api

https://gamejolt.com

Esta biblioteca proporciona cobertura completa (excepto por lotes) de la API de Game Jolt (trofeos, puntuaciones, sesiones, etc.). Por el momento, esta biblioteca está escrita y probada para la versión 1.2 de la API de Game Jolt.

Instalación

$ composer require " harrk/gamejolt-api " 

Uso

Cree una instancia de GamejoltApi y proporcione GamejoltConfig para comenzar a realizar llamadas API a Game Jolt.

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

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

Puntos finales

A continuación se muestran ejemplos de cómo interactuaría con cada punto final. Tenga en cuenta que estos son sólo ejemplos y es posible que no utilicen todas las opciones de parámetros.

Consulta la documentación de la API de Game Jolt o el código fuente para obtener más opciones.

Almacén de datos

La API de Data Store se puede utilizar para almacenar/recuperar datos en la nube.

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

Amigos

La API de amigos solo se puede utilizar para encontrar los ID de amigo del usuario actual.

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

Montones

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

Sesiones

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

Tiempo

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

Trofeos

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

Usuarios

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

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

Detectar excepciones

A continuación se muestra un ejemplo de cómo detectar excepciones:

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

Pruebas

Se han proporcionado dos comandos para simplificar la ejecución de las pruebas.

Ejecutar pruebas unitarias

$ composer test

Ejecutar análisis de código estático

$ composer analyse

Hacer

• Permitir el método POST en los puntos finales
• Incrementar la cobertura de Pruebas Unitarias

Licencia

Licencia MIT