Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
This example seeks to help developers understand how to access the /lists/delete endpoint.
<?php
/**
* This example seeks to help developers understand how to access the /lists/delete endpoint.
*/
if ( !class_exists( 'Example_API_Calls' )) {
class Example_API_Calls {
static $key;
static $token;
static $base_api_url;
static $complete_api_url;
static $endpoint;
static $data;
static $response;
/**
* initiates class
*/
public function __construct() {
/* Define API Credentials for testing - used by connect() method below */
self::$key = '91866f1c792f003fc986e3783ca71e88';
self::$token = 'eaa9be109fc204dee7dfd7d7a94184d9';
self::$base_api_url = 'http://www.yoursite.com/inbound-api/v1/';
}
/**
* Determines connect method and makes a request to the API
*
*
*/
public static function connect() {
$connect = (isset($_GET['connect'])) ? $_GET['connect'] : 'curl';
switch ( $connect ) {
case 'curl' :
self::curl_connect( self::$endpoint , self::$data );
BREAK;
}
}
/**
* Uses CURL to connect to Inbound API
*/
public static function curl_connect( $endpoint , $data ) {
$api_url = add_query_arg( array('key' => self::$key , 'token' => self::$token ), self::$base_api_url . $endpoint );
$ch = curl_init( $api_url );
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
self::$response = curl_exec($ch);
self::check_response( $endpoint , $data );
}
/**
* Returns data from the API call for review.
*/
public static function check_response() {
echo 'API Key: '. self::$key .'<br>';
echo 'API Token: '. self::$token .'<br>';
echo 'API Endpoint: '. self::$endpoint .'<br>';
echo '<b>Response</b>:<br>';
echo '<div class="toggle" id="'.$id.'">';
echo '<pre>';
echo self::$response;
echo '</pre>';
echo '</div><br><br>';
}
/**
* Example API Query: Changes a lead list name
* @endpoint lists/delete
*/
public static function delete_list() {
/* Sets endpoint to http://www.yoursite.com/inbound-api/v1/lists/modify */
self::$endpoint = 'lists/delete';
self::$query_description = 'deletes a lead lists';
/* Prepare an example lead dataset - this data will be sent to the API */
self::$data = array( 'id' => 122 );
/* Connect to the API and print data results */
self::connect();
}
}
/* Initialize Class */
$Example_API_Calls = new Example_API_Calls();
/* Add a lead list to the Leads database */
$Example_API_Calls->delete_list();
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment