Skip to content

Latest commit

 

History

History
52 lines (45 loc) · 1.82 KB

README.md

File metadata and controls

52 lines (45 loc) · 1.82 KB
Raw

pipelinedeals-php-api

Please note that I am not longer continuing active development since I've stopped using PipelineDeals and switched from PHP to Python. I am more than happy to accept pull requests though!

Table of Contents

  1. Requirements
  2. Usage
  3. Examples

Requirements

  • PHP with cURL
  • Pipelinedeals Account with API-Access

Usage

Instantiate Class

$pda = new PDAdapter(api-key,custom-base-url);
  • api-key: Your Pipelinedeals API-Key
  • custom-base-url: Set a custom base url for API requests (advanced users only, see source for further information)

Set Request Method (optional)

$pda->setMethod(method);
  • method: The method of your request. Either 'get' (default), 'post' or 'put'

Do a Request to Pipelinedeals

$result = $pda->doRequest(resource, conditions, page, request-data)
  • resource: the wanted Pipelinedeals resource. E.g.: 'people', see the Pipelinedeals-API-Documentation for further information (http://www.pipelinedeals.com/developers/api)
  • conditions (optional): Conditions in key=>value array, e.g.: "array('[deal_created][from_date]'=>'2011-01-01','[deal_created][to_date]' => '2012-01-01')"
  • page (optional): The wanted page as integer, e.g.: "2"
  • request-data (optional): Needed for requests which send data with themselves, for e.g. creating a deal.

Examples

Full example getting a list of all people

$pda = new PDAdapter($api_key); $result = $pda->doRequest("people");

That's only two lines - see how easy that is?