bmilesp/endpoints

There is no license information available for the latest version (dev-master) of this package.

Simple CakePHP API endpoints plugin for simplicity in connecting to API endpoints

dev-master 2015-02-27 15:17 UTC

Requires

• composer/installers: ~1.0

Unknown License

• bmilesp

README

Simple CakePHP API endpoints plugin for simplicity in connecting to API endpoints

Requirements

CakePHP => 2.1

Installation

[Using Composer]

View on Packagist, and copy the json snippet for the latest version into your project's composer.json. Eg, v. 2.1.x-dev would look like this:

{
	"require": {
		"bmilesp/endpoints": "2.1.x-dev"
	}
}

Enable plugin

Add following lines in yout app/Config/bootstrap.php file

Create a database config variable that uses the Endpoints.ApiSource datasource, and the API domain as the host:

	
	public $website_source = array(
    	'datasource' => 'Endpoints.ApiSource',
    	'host' => 'website.com'
    );

Then setup the model by using the behavior and datasource we've just setup:

	
	public $uses = array('website_source');
	public $actsAs = array('Endpoints.Endpint');

Usage

To send and retrieve data from an endpoint. here is an example:

	function unlock($slug = null){
		$postData = array('id' => 23);
		$result = $this->callEndpoint('/users/get_user_by_id',$postData);
		return $result->body; 	
	}