masmaleki / laravel-mautic-api
Free and Open Source Marketing Automation API for laravel 8
Requires
- php: ^7.3|^8.2
- graham-campbell/manager: ^5.1
- guzzlehttp/guzzle: ^7.2
- laravel/framework: ^8.0|^9.0|^10.0|^11.0
- mautic/api-library: ^3.1
README
Free and Open Source Marketing Automation API
Requirements
- PHP 5.5.* or newer
- cURL support
Mautic Setup
The API must be enabled in Mautic. Within Mautic, go to the Configuration page (located in the Settings menu) and under API Settings enable Mautic's API. You can also choose which OAuth2 protocol to use here. After saving the configuration, go to the API Credentials page (located in the Settings menu) and create a new client. Enter the callback/redirect URI that the request will be sent from. Click Apply then copy the Client ID and Client Secret to the application that will be using the API.
Installation
First, you'll need to require the package with Composer:
composer require masmaleki/laravel-mautic-api
Aftwards, run composer update
from your command line.
Then, update config/app.php
by adding an entry for the service provider.
'providers' => [ // ... 'masmaleki\Mautic\MauticServiceProvider', ],
Then, register class alias by adding an entry in aliases section
'aliases' => [ //..... 'Mautic' => 'masmaleki\Mautic\Facades\Mautic', ],
Finally, from the command line run php artisan vendor:publish
to publish the default configuration file.
This will publish a configuration file name mautic.php
,consumer migration
and consumer model
.
Run php artisan migrate
migration command to create consumer table in your database.
Configuration
You need to add your client id
, client secret
and callback url
in mautic.php
file that is found in your applications config
directory.
Authorization
This Library only support OAuth2 Authorization you must need to create a OAuth2 client in order to use api.
Registering Application
In order to register you application with mautic ping this url this is one time registration.
http://your-app/mautic/application/register
Usage
Add Mautic Facade in your controller.
use Mautic;
Send a request to mautic ( Example )
Create a new contact in mautic.
$params = array( 'firstname' => 'Edison', 'lastname'=> 'Costa', 'email' => 'edison@keepcloud.io' ); Mautic::request('POST','contacts/new',$params);
Get List of all contacts
Mautic::request('GET','contacts');
Get a unique contact
Mautic::request('GET','contacts/1'); //where 1 is unique id for a contact.
Delete a contact
Mautic::request('Delete','contacts/1/delete');
And many more endpoints support by mautic.
List of Endpoints supported by Mautic.
Contacts
[ "contacts", "contacts/{id}", "contacts/list/fields", "contacts/list/owners", "contacts/new", "contacts/{id}/edit", "contacts/{id}/delete", "contacts/{id}/notes", "contacts/{id}/segments", "contacts/{id}/campaigns" ]
Assets
[ "assets", "assets/{id}" ]
Campaigns
[ "campaigns", "campaigns/{id}", "campaigns/contact/{id}/add/{leadId}", "campaigns/contact/{id}/remove/{leadId}" ]
Data
[ "data", "data/{type}", ]
Emails
[ "emails", "emails/{id}", "emails/{id}/send", "emails/{id}/send/lead/{leadId}" ]
Forms
[ "forms", "forms/{id}" ]
Pages
[ "pages", "pages/{id}" ]
Points
[ "points", "points/{id}", "points/triggers", "points/triggers/{id}" ]
Reports
[ "reports", "reports/{id}" ]
Segments
[ "segments", "segments/contact/{id}/add/{leadId}", "segments/contact/{id}/remove/{leadId}" ]
Users
[ "roles", "roles/{id}", "users", "users/{id}", "users/list/roles", "users/self", "users/{id}/permissioncheck", ]
Please refer to Documentation. for all customizable parameters.