nielsvandoorn/pipedrive

This package is abandoned and no longer maintained. No replacement package was suggested.

A Laravel package to use the Pipedrive API

dev-master 2016-01-12 18:12 UTC

This package is not auto-updated.

Last update: 2020-01-28 20:12:29 UTC


README

This package helps you to build an Laravel application that uses the Pipedrive CRM API.

Installation

Note: This package is currently under development and not production ready. Functions / classnames may change overtime.

$ composer require nielsvandoorn/pipedrive

Or manually add the following line to your composer.json

"require": {
    "nielsvandoorn/pipedrive": "dev-master"
}

Getting started

After installing the package through composer you need to add the service provider to your Laravel application. (Sample is for 5.1+)

Add the following line to config/app.php in the providers array:

Nielsvandoorn\Pipedrive\PipedriveServiceProvider::class

After that you need to publish the configuration file. This is done by running the following command in your terminal:

php artisan vendor:publush

This will publish the config/pipedrive.php file with the following contents:

<?php
return [
    'endpoint' => 'https://api.pipedrive.com/v1/',
    'api_token' => ''
];

Fill in your API token.

Usage

Use the Nielsvandoorn/Pipedrive class.

use Nielsvandoorn\Pipedrive;

Get all persons

$pipedrive = new Pipedrive\Pipedrive();
$pipedrive->person()->all();

Get all persons, show first and last name

$pipedrive = new Pipedrive\Pipedrive();
$pipedrive->person()->all(['first_name', 'last_name']);

Find a person by id

$pipedrive = new Pipedrive\Pipedrive();
$pipedrive->person()->find(1);

Find a person by id, show first and last name

$pipedrive = new Pipedrive\Pipedrive();
$pipedrive->person()->find(1);

To Do

  • Finish entities
    • Persons
    • Organizations
    • Activities
    • Deals
    • Goals
    • Notes
    • Products
  • Add DocBlocks
  • Generate PhpDoc
  • Write detailed documentation