https://github.com/lasserafn/laravel-pipedrive
A pipedrive integration for Laravel
https://github.com/lasserafn/laravel-pipedrive
api api-wrapper laravel pipedrive
Last synced: about 1 year ago
JSON representation
A pipedrive integration for Laravel
- Host: GitHub
- URL: https://github.com/lasserafn/laravel-pipedrive
- Owner: LasseRafn
- License: mit
- Created: 2016-11-17T13:37:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-08-22T01:36:05.000Z (almost 7 years ago)
- Last Synced: 2025-04-09T20:05:58.592Z (about 1 year ago)
- Topics: api, api-wrapper, laravel, pipedrive
- Language: PHP
- Size: 40 KB
- Stars: 2
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Pipedrive API wrapper
## Installation
1. Require using composer
``` bash
composer require lasserafn/laravel-pipedrive
```
2. (For laravel **5.4 and below**) Add the PipedriveServiceProvider to your ````config/app.php```` providers array.
``` php
'providers' => [
\LasseRafn\Pipedrive\PipedriveServiceProvider::class,
]
```
3. Publish config file.
``` bash
php artisan vendor:publish --provider "LasseRafn\Pipedrive\PipedriveServiceProvider"
```
## Usage
### Create Pipedrive Instance
``` php
$pipedrive = new \LasseRafn\Pipedrive\Pipedrive($APIKEY); // or set the api key in the config/pipedrive.php file.
```
To find your API key you must login to Pipedrive and navigate to Settings -> Personal -> Api (/settings#api)
### Get all Persons
``` php
$pipedrive->persons()->all(); // Returns a collection of Person models.
```
### Find Person by ID
``` php
$pipedrive->persons()->find(1); // Returns a Person model.
```
### Get a list of Activities that are not done
Filters consist of an array of arrays. The first parameter is included fields, leave it at `null` to keep the default.
``` php
$pipedrive->activities()->all(null, [ [ 'done' => 0 ] ]);
```
(Later versions will switch to a single array key => value).
## Supported endpoints
... Todo
## Testing
... Todo
## [Contributors](https://github.com/LasseRafn/laravel-pipedrive/graphs/contributors)