View source for Integration:api

<div style="background-color: #FF0000; color: #000000; width: 100%; padding: 10px; margin-bottom: 10px;"><i class="fa fa-exclamation-triangle"></i> Please note that our API is currently very limited.</div>
<div style="background-color: #1fa67a; color: #fff; width: 100%; padding: 10px;"><i class="fa fa-info-circle"></i> This page is recommended only for <strong>advanced users</strong>. If you don't have any familiarity with PHP or APIs, consider getting a developer to look this over for you. Support is <b>not provided</b> with the API.</div>
<br>
===WHAT IS THIS API? WHAT DOES IT DO?===
An API (short for "Application Program Interface"), is a way of communication with a system both internally and externally. It allows you to perform actions or receive data from/to a system. Prometheus uses an API to allow you to perform various actions using a script remotely.

===WHAT CAN I DO WITH THE API?===
With Prometheus, you can do the following things currently:

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

===API VARIABLES===
The API has a few things you can designate:

*''hash'' - The hash is the API key you created when enabling the API from your Prometheus admin dashboard. 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:

<code>http://yourprometheuswebsiteurl.com/api.php?hash=HASH&action=ACTION</code>

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
!getPackages
|-
!Hash
|No
|Yes
|Yes
|Yes
|-
!Properties
|None
|steamid, package
|steamid, amount
|None
|-
!Returns
|error, cur, total, goal
|error, msg
|error, msg
|error, packages
|}

===== 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']);
        }
 
  ?>