Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.24 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.24 KB

Highrise-PHP

A PHP toolkit for accessing the Highrise API.


Installation

To install simply include the Highrise.php file in your PHP script, and instantiate the class.

include('/path/to/Highrise.php');
$client = new Highrise('my-subdomain', 'my-token');

Usage

Once you have authenticated you can begin using the toolkit to call the API.

GET requests

GET requests are made to get existing resources, and work as follows:

$client->get('resource_name', array('optional_param' => 'value'));

POST requests

POST requests are made to create new resources, and work as follows:

$client->post('resource_name', array('required_param' => 'value'));

PUT requests

PUT requests are made to update existing resources, and work as follows:

$client->put('resource_name', array('param_to_update' => 'value'));

DELETE requests

DELETE requests are made to delete existing resources, and work as follows:

$client->delete('resource_name');

Resources

The list of resources consumable by the API can be found at https://github.com/37signals/highrise-api

Support

If you require help or further explanation, feel free to message us on twitter (@thoughtco @ryanhmitchell)