PrometheusIPN Wiki - User contributions [en]

Integration:api

2015-08-01T01:48:42Z

198.41.243.113:

Integration:api

2015-08-01T01:41:48Z

198.41.243.113:

====== The API ======
===== What is this api? =====
An API(Application Program Interface), is a way of communication with a system both internally and externally. With Prometheus this allows you to do the following things currently:

Add a package to a user(Using Steam64 or SteamID)
Get donation goal info

The API has a few things you can designate:

''hash'' - The hash you generate above if you enable API. This has to be kept a secret. Do not give it to anyone else.

''action'' - The performed action

''steamid'' - The users steamid

''package'' - The package

===== How do I use it? =====
The API is accessed by typing this into your browser:

http://yourprometheus.com/api.php?hash=HASH&action=ACTION

Not all actions require a hash, for instance the getGoal action does not require a hash and can be accessed directly. The API returns the response in **JSON**. It can be securely communicated with using **cURL**.

===== List of actions =====

{| class="wikitable"
|+Api calls
|-
!Action
|getGoal
|assignPackage
|addCredits
|-
!Hash
|No
|Yes
|Yes
|-
!Properties
|None
|steamid, package
|steamid, amount
|-
!Returns
|error, cur, total, goal
|error, msg
|error, msg
|}

===== Examples =====
==== getGoal Example ====

'''getGoalExample.php'''
<?php

$get = file_get_contents('http://marcuz.eu/ipn/api.php?action=getGoal');
$array = json_decode($get, true);

if($array['error'] == 0){
$percentage = $array['perc'];
$total = $array['total'];
$goal = $array['goal'];
$currency = $array['cur'];

echo '
<b>Goal:</b> '.$goal.' '.$currency.'<br>
<b>Received:</b> '.$total.' '.$currency.'<br>
<b>Percentage:</b> '.$percentage.'%
';
}

?>

==== assignPackage Example ====

'''assignPackageExample.php'''
<?php

// Replace everything in uppercase letters with your own information
$source = 'http://yourprometheus.com/api.php?hash=YOUR_HASH&action=assignPackage&package=PACKAGE_ID&steamid=STEAM64_OR_STEAMID';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $source);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSLVERSION,4);
$data = curl_exec($ch);
$error = curl_error($ch);
curl_close ($ch);

if($data === false) {
// Display an error if there is any
die('Curl error: ' . $error);
}

// Decode the data response
$array = json_decode($data, true);

// Display an error if there is any
if($array['error'] == 1){
die($array['msg']);
}

// Display success message
if($array['error'] == 0){
echo($array['msg']);
}

?>

'''assignPackageExample2.php'''
Give a package only if the user has a specific key

URL: http://yourprometheus.com/assignPackageExample2.php?key=2839123yb293y8239y1231b9y32

<?php
SESSION_START();
if(isset($_SESSION['uid')){
// Replace this
$SUPERSECRETKEY = '2839123yb293y8239y1231b9y32';
$api_hash = ''; // API hash
$package = 0; // Package ID
$url = 'http://yourprometheus.com'; // Your site url, including sub directory. But no trailing /

// DO NOT EDIT PAST THIS LINE //
if($_GET['key'] == $SUPERSECRETKEY){
// Replace everything in uppercase letters with your own information
$source = $url . '/api.php?hash='.$api_hash.'&action=assignPackage&package='.$package.'&steamid=' . $_SESSION['uid'];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $source);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSLVERSION,4);
$data = curl_exec($ch);
$error = curl_error($ch);
curl_close ($ch);
if($data === false) {
// Display an error if there is any
die('Curl error: ' . $error);
}
// Decode the data response
$array = json_decode($data, true);
// Display an error if there is any
if($array['error'] == 1){
die($array['msg']);
}
// Display success message
if($array['error'] == 0){
echo($array['msg']);
}
} else { echo 'Secret key is invalid'; }
} else {
echo 'Not logged in. <a href=".">Go back</a>';
}
?>

Integration:api

2015-08-01T01:41:25Z

198.41.243.113:

Integration:api

2015-08-01T01:38:02Z

198.41.243.113:

====== The API ======
===== What is this api? =====
An API(Application Program Interface), is a way of communication with a system both internally and externally. With Prometheus this allows you to do the following things currently:

Add a package to a user(Using Steam64 or SteamID)
Get donation goal info

The API has a few things you can designate:

''hash'' - The hash you generate above if you enable API. This has to be kept a secret. Do not give it to anyone else.

''action'' - The performed action

''steamid'' - The users steamid

''package'' - The package

===== How do I use it? =====
The API is accessed by typing this into your browser:

http://yourprometheus.com/api.php?hash=HASH&action=ACTION

Not all actions require a hash, for instance the getGoal action does not require a hash and can be accessed directly. The API returns the response in **JSON**. It can be securely communicated with using **cURL**.

===== List of actions =====

{| class="wikitable"
|+Api calls
|-
!Action
|getGoal
|assignPackage
|addCredits
|-
!Hash
|No
|Yes
|Yes
|-
!Properties
|None
|steamid, package
|steamid, amount
|-
!Returns
|error, cur, total, goal
|error, msg
|error, msg
|}

===== Examples =====
==== getGoal Example ====

'''getGoalExample.php'''
<?php

$get = file_get_contents('http://marcuz.eu/ipn/api.php?action=getGoal');
$array = json_decode($get, true);

if($array['error'] == 0){
$percentage = $array['perc'];
$total = $array['total'];
$goal = $array['goal'];
$currency = $array['cur'];

echo '
<b>Goal:</b> '.$goal.' '.$currency.'<br>
<b>Received:</b> '.$total.' '.$currency.'<br>
<b>Percentage:</b> '.$percentage.'%
';
}

?>

==== assignPackage Example ====

'''assignPackageExample.php'''
<?php

// Replace everything in uppercase letters with your own information
$source = 'http://yourprometheus.com/api.php?hash=YOUR_HASH&action=assignPackage&package=PACKAGE_ID&steamid=STEAM64_OR_STEAMID';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $source);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSLVERSION,4);
$data = curl_exec($ch);
$error = curl_error($ch);
curl_close ($ch);

if($data === false) {
// Display an error if there is any
die('Curl error: ' . $error);
}

// Decode the data response
$array = json_decode($data, true);

// Display an error if there is any
if($array['error'] == 1){
die($array['msg']);
}

// Display success message
if($array['error'] == 0){
echo($array['msg']);
}

?>

'''assignPackageExample2.php'''
Give a package only if the user has a specific key

URL: http://yourprometheus.com/assignPackageExample2.php?key=2839123yb293y8239y1231b9y32

<code php>
<?php
SESSION_START();
if(isset($_SESSION['uid')){
// Replace this
$SUPERSECRETKEY = '2839123yb293y8239y1231b9y32';
$api_hash = ''; // API hash
$package = 0; // Package ID
$url = 'http://yourprometheus.com'; // Your site url, including sub directory. But no trailing /

// DO NOT EDIT PAST THIS LINE //
if($_GET['key'] == $SUPERSECRETKEY){
// Replace everything in uppercase letters with your own information
$source = $url . '/api.php?hash='.$api_hash.'&action=assignPackage&package='.$package.'&steamid=' . $_SESSION['uid'];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $source);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSLVERSION,4);
$data = curl_exec($ch);
$error = curl_error($ch);
curl_close ($ch);
if($data === false) {
// Display an error if there is any
die('Curl error: ' . $error);
}
// Decode the data response
$array = json_decode($data, true);
// Display an error if there is any
if($array['error'] == 1){
die($array['msg']);
}
// Display success message
if($array['error'] == 0){
echo($array['msg']);
}
} else { echo 'Secret key is invalid'; }
} else {
echo 'Not logged in. <a href=".">Go back</a>'
}
?>
</code>

Integration:api

2015-08-01T01:36:53Z

198.41.243.113:

Integration:api

2015-08-01T01:35:57Z

198.41.243.113:

Integration:api

2015-07-31T21:58:02Z

198.41.243.113:

Integration:api

2015-07-31T21:57:36Z

198.41.243.113:

Integration:api

2015-07-31T21:56:44Z

198.41.243.113:

Integration:api

2015-07-31T21:53:52Z

198.41.243.113:

Integration:api

2015-07-31T21:52:55Z

198.41.243.113: Created page with "====== The API ====== ===== What is this api? ===== An API(Application Program Interface), is a way of communication with a system both internally and externally. With Prometh..."

Main Page

2015-07-31T21:52:39Z

198.41.243.113:

{{MainSidebar}}
{{CatStartNewMain|About PrometheusIPN}}
<div>
PrometheusIPN is a Garry's Mod donation system. It is available for purchase on ScriptFodder. There's a link on the right hand side and below. PrometheusIPN is still work-in-progress which means it is not at a 'feature complete' state from a developer stand-point. <br><br>Prometheus IPN provides you, as a server owner, the tools you need to manage your donations in an easy and simple way. With Prometheus you no longer need to worry about manually giving your users the donator benefits they purchase, Prometheus does it for you!<br><br>
{{MainButtons|Buy Prometheus|Translate Prometheus}}
</div>

<div>
{{CatStartNewMoreCategory|Installation}}
{{CatItemNew|check-circle|:Installation:requirements|Requirements|Requirements}}
{{CatItemNew|html5|:Installation:website|Website|Website installation}}
{{CatItemNew|check-circle|:Installation:lua_prerequisites|Lua prerequisites|Lua prerequisites}}
{{CatItemNew|code|:Installation:lua|Lua|Lua installation}}
{{CatItemNew|search|:Installation:debugging|Debugging|Help debugging your Prometheus installation}}
|}
</div>

<div>
{{CatStartNewMoreCategory|Packages}}
{{CatItemNew|server|:packages:servers|Servers|Adding a server}}
{{CatItemNew|cubes|:packages:adding|Packages|Adding a package}}
{{CatItemNew|money|:packages:credit|Credits|Adding a credit package}}
{{CatItemNew|cubes|:packages:assigning|Assigning|Manually assigning a package}}
|}
</div>

<div>
{{CatStartNewMoreCategory|Dashboard}}
{{CatItemNew|pie-chart|:dashboard:statistics|Statistics|Dashboard statistics}}
{{CatItemNew|dollar|:dashboard:sales|Sales|How to set up a sale}}
{{CatItemNew|users|:dashboard:users_transactions|Users/Transactions|Users and transactions}}
{{CatItemNew|map|:dashboard:updating|Updating|How to update Prometheus}}
|}
</div>

<div>
{{CatStartNewMoreCategory|Configuration}}
{{CatItemNew|cogs|:settings:settings|Settings|Prometheus settings}}
{{CatItemNew|sticky-note|:settings:notifications|Notifications|Ingame notifications}}
|}
</div>

<div>
{{CatStartNewMoreCategory|Integration}}
{{CatItemNew|money|:integration:gateways|Payment Gateways|Payment Gateways}}
{{CatItemNew|microphone|:integration:teamspeak3|Teamspeak 3|Teamspeak 3 Integration}}
{{CatItemNew|code|:integration:api|API|Prometheus API}}
|}
</div>

Installation:debugging

2015-07-30T20:21:17Z

198.41.243.113:

====== Debugging ======
If you have any issues with Prometheus you should always read this article first:

===== MySQL not connecting =====

* Make sure you have MySQL remote connections enabled on your webhost's controlpanel, and your GMod server's IP whitelisted. Also make sure you have the MySQLoo module [[installation:lua|installed correctly]].

===== MySQL Server has gone away =====

* Set your refreshrate in your lua config to 15 seconds or less. Your MySQL server does not allow any connections that last longer than 15 seconds most likely, so it's timing out before its hitting the default 40.
* To fix this run these two commands in your MySQL (If you can't, get your host to do it):
SET @@GLOBAL.wait_timeout=300;
SET @@LOCAL.wait_timeout=300;

===== I do not receive the test message on my server =====

* Enable the launch parameter -condebug on your server unless you are using TCAdmin 2.0 already.
* **If you are using TCAdmin 2.0** View your server console upon starting your server and look for anything that says Prometheus. or "Database connection failed".
* **If using -condebug** Do the same thing as above, but in the console.log file within your GMod servers "Garrysmod" directory

===== I do receive the test message, but don't get the items in my server =====

==== Nothing appearing in the transaction log of Prometheus ====

* You have not set up your Prometheus properly following this [[installation:website|installation tutorial]]. Your PayPal is receiving the money, but is not sending a pingback message to your webserver.

<br><br>
[[File:pingback.png|400px]]
<br><br>

Your system is failing at the red arrow (Inbetween PayPal and your installation). You need to set your IPN URL in PayPal itself. See the installation tutorial link above.

==== Something appearing in the transaction log of Prometheus ====

* Your serverID is most likely incorrect in your lua config. To find your actual serverID go to Admin-> Servers and edit a server to see the ID.

===== Parse error unexpected '[' =====

* You do not have the latest PHP 5.4 version or greater installed on your webserver