142 lines
5 KiB
Markdown
142 lines
5 KiB
Markdown
# LDC CRM api
|
|
|
|
Api client for CRM V4
|
|
|
|
**Client version must match CRM version !!**
|
|
|
|
|
|
- [LDC CRM api](#ldc-crm-api)
|
|
- [**Installation**](#installation)
|
|
- [**Usage**](#usage)
|
|
- [**Using Laravel**](#using-laravel)
|
|
- [**Using any other project**](#using-any-other-project)
|
|
- [**Using Wordpress**](#using-wordpress)
|
|
- [**Using custom implementation and calling directly CRM**](#using-custom-implementation-and-calling-directly-crm)
|
|
- [**More information**](#more-information)
|
|
- [**Customer Informations**](#customer-informations)
|
|
- [**Change log**](#change-log)
|
|
- [**Testing**](#testing)
|
|
- [**Credits**](#credits)
|
|
- [**License**](#license)
|
|
|
|
## **Installation**
|
|
|
|
Multiple ways are possible. You may include the client directly into your project using composer. You will need to have access to this repos. If you read this it may already be the case. So using ``composer update`` or ``composer require ldc/ldccrmv4client`` should be enough.
|
|
|
|
*This has few dependencies it may not interfer with your project.*
|
|
|
|
"ext-curl": "^7.3",
|
|
"php": "^7.3",
|
|
"guzzlehttp/guzzle": "^7.4",
|
|
"respect/validation": "^2.2"
|
|
|
|
## **Usage**
|
|
|
|
As for initialisation multiple ways are possible.
|
|
If you are in a laravel project you can map a singleton of the crm api.
|
|
|
|
### **Using Laravel**
|
|
|
|
1. Setup ``config/crm.php``
|
|
|
|
<?php
|
|
|
|
return [
|
|
'endpoint' => 'https://ldc-crm.ldc.fr',
|
|
'token' => 'YOUR_API_TOKEN',
|
|
'password' => 'YOUR_API_PASSWORD'
|
|
];
|
|
|
|
2. Make a crm singleton if needed *(optional)*
|
|
|
|
// In AppServiceProvider.php
|
|
App::singleton('CrmApiV4', function () {
|
|
return new CrmApiV4();
|
|
});
|
|
|
|
// You then like this.
|
|
/** @var \LDC\LDCCRM\CrmApiV4 $crmApi */
|
|
$crmApi = app('CrmApiV4);
|
|
|
|
// Or directly use static methods.
|
|
/** @var \LDC\LDCCRM\Models\Customer|null $customer */
|
|
$customer = Customer::find('UUID');
|
|
|
|
### **Using any other project**
|
|
|
|
Setup once the main class *(it is already a singleton, no need to manage it)*.
|
|
|
|
Informations will be kept in memory as static meaning all instance of CrmApiV4 or any class (Customer, ..) will share the same informations as credentials.
|
|
|
|
$crmToken = 'YOUR_API_TOKEN';
|
|
$crmPassword = 'YOUR_API_PASSWORD';
|
|
|
|
// This has to hapen once. It will be kept in memory;
|
|
new CrmApiV4('https://ldc-crm.ldc.fr', $crmToken, $crmPassword);
|
|
|
|
### **Using Wordpress**
|
|
|
|
We created as experimental some wordpress classes. It will handle locale storage (in sql database) and sessions using start session. Some security is provided with a settion time out of 15 minutes. A fingerprint is set using the user agent and remote_ip. These cannot be trusted and it wont prevent a replay attack though.
|
|
Usefull to point out that you make not use this without ssl (https) connection.
|
|
|
|
The usage is that same as for *setting up for any other project*, bu instead you can make usage of class in the ``LDC\LDCCRM\WordPress`` namespace.
|
|
|
|
**Note: using methods from classes in this namespace will call php session_start if it has not started yet**
|
|
|
|
// If true from here; user session is set and will be remembered until timeout or WPCRM::logout.
|
|
$status = WPCRM::login('customer@email.com', 'password');
|
|
|
|
### **Using custom implementation and calling directly CRM**
|
|
|
|
You may implement your own call to fit your needs. If you wish to go this way please read [these instructions](docs/usages/custom.md).
|
|
|
|
### **More information**
|
|
|
|
- Using [WordPress client](docs/usages/wordpress-client.md)
|
|
- Using [normal client](docs/usages/client.md)
|
|
- Writing [your own implementation](docs/usages/custom.md)
|
|
|
|
## **Customer Informations**
|
|
|
|
The CRM will store multiple informations about your customer. Of course you can contact us if there is a **RGPD** demand to access or suppress information. Also we store the following informations as for now :
|
|
|
|
- last connection
|
|
- password
|
|
- email
|
|
- first name
|
|
- last name
|
|
- birth date
|
|
- address
|
|
- phone
|
|
- country
|
|
- city
|
|
- postcode
|
|
- opt in status and history
|
|
- question answers
|
|
|
|
**Password is stored as hashed using strong algorithm and a secret key, no logs are done while authenticating your customer other than the connection date if auth is successful**
|
|
|
|
***You may also note that every customer has a HASHCODE, this is the ID of your customer and has to be stored on your side. But even if you don't you can always identify your customers using it's email.***
|
|
|
|
Minimal informations you may keep are :
|
|
|
|
- hashcode
|
|
- email
|
|
|
|
|
|
## **Change log**
|
|
|
|
Please see the [changelog](changelog.md) for more information on what has changed recently.
|
|
|
|
## **Testing**
|
|
|
|
All unit test are included in the crm source code, meaning you do not have access to them. If you wish you can override any source code, write your own test, but data will still be validated on crm side.
|
|
|
|
|
|
## **Credits**
|
|
|
|
- [Jérémy Munsch](https://jeremydev.ovh)
|
|
|
|
## **License**
|
|
|
|
MIT. Please see the [license file](license.md) for more information.
|