Difference between revisions of "Integration:api"

From PrometheusIPN Wiki
Jump to: navigation, search
(What is this api?)
(The API)
Line 1: Line 1:
====== The API ======
+
Dick
<nowiki><nowiki>Insert non-formatted text here</nowiki><nowiki><nowiki>Insert non-formatted text here</nowiki><nowiki><nowiki>Insert non-formatted text here</nowiki><nowiki><nowiki>Insert non-formatted text here</nowiki><nowiki><nowiki>Insert non-formatted text here</nowiki></nowiki></nowiki></nowiki></nowiki></nowiki>===== What is this api? =====
 
 
 
 
 
Add a packddddd
 
 
 
The API has a few things you can designate:
 
 
 
''hash'' - The hasdddh you genfferate above if you enable API. This has to be kept a secret. Do not give it to anyone else.
 
 
 
''action'' - The perforffmed action
 
 
 
''steamid'' - The users steamidegddgdg
 
fvvd
 
''package'' - The package
 
cc dcvdv
 
  
 
===== How do I use it? =====
 
===== How do I use it? =====

Revision as of 21:17, 26 August 2016

Dick

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
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 '
                      Goal: '.$goal.' '.$currency.'
Received: '.$total.' '.$currency.'
Percentage: '.$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']);
       }

 ?>