laravel_crm / capsulecrm
Laravel Package for capsule CRM integration
1.0.1
2018-04-11 09:51 UTC
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~6.0
This package is auto-updated.
Last update: 2024-09-09 22:57:11 UTC
README
laravelCapsuleCRM
Agenda
Installation
- Install from composer
composer require laravel_crm/capsulecrm
- Add Service Provider in
config/app.php
add service provider class
'providers' => [ CapsuleCRM\CapsuleServiceProvider::class, ];
- And add alias in
config/app.php
inaliases
array add
'aliases' => [ 'CapsuleCRM'=>CapsuleCRM\Facades\CapsuleCRM::class, ];
- Publish config file by
php artisan vendor:publish --tag=capsuleCRM --force
Configuration
- Add in
.env
file three keys of capsulecrm :CAPSULECRM_TOKEN
get it from capsuleMy Preferences
->API Authentication Tokens
->Personal Access Tokens
CAPSULECRM_APP_NAME
CAPSULECRM_BASE_URI
default ishttps://api.capsulecrm.com/api/v2/
Usage
Common usage :
CapsuleCRM::{entity name}()
Example :
CapsuleCRM::party()
- Party: Parties represent the People and Organisations on your Capsule account. His Object is :
CapsuleCRM::party();
for crud operations :
- Create new account :
$data = [ 'name' => 'youssef daood', 'email' => 'ydaood@arkdev.net', 'tags' => ['register','subscribe'] ]; CapsuleCRM::party()->create($data);
- Resgister account:
$data = [ 'name' => 'youssef daood', 'email' => 'ydaood@arkdev.net' ]; $tag = 'subscribe'; CapsuleCRM::party()->register($data, $tag);
- Update account:
$id = 1; // id of capsule $data = [ 'name' => 'youssef' ]; CapsuleCRM::party()->update($id, $data);
- validateUniqueEmail:
$email = 'ydaood@arkdev.net'; CapsuleCRM::party()->validateUniqueEmail($email);
- Search
$filter = 'youssef'; CapsuleCRM::party()->search($filter);
- Fetch one party
$party_id=123456; $party = CapsuleCRM::party()->fetch($party_id);
- Get all person objects for a party
$party_id=123456; $people = CapsuleCRM::party()->people($party_id);