README

免费且开源的营销自动化API

需求

PHP 5.5.* 或更高版本
cURL 支持

Mautic 设置

API必须在Mautic中启用。在Mautic中，转到配置页面（位于设置菜单中），在API设置下启用Mautic的API。您还可以在此处选择要使用的OAuth2协议。保存配置后，转到API凭据页面（位于设置菜单中），创建一个新的客户端。输入请求将从中发送的回调/重定向URI。点击应用，然后将客户端ID和客户端密钥复制到使用API的应用程序中。

安装

首先，您需要使用Composer要求此包

composer require gentor/laravel-mautic-api

之后，从您的命令行运行 composer update。

然后，通过在服务提供程序部分添加条目来更新 config/app.php。

'providers' => [
    // ...
    'Princealikhan\Mautic\MauticServiceProvider',
],

然后，通过在别名部分添加条目来注册类别名

'aliases' => [
    // ...
    'Mautic' => 'Princealikhan\Mautic\Facades\Mautic',
],

最后，从命令行运行 php artisan vendor:publish 以发布默认配置文件。这将发布一个名为 mautic.php 的配置文件，consumer migration 和 consumer model。

运行 php artisan migrate 迁移命令以在您的数据库中创建消费者表。

配置

您需要在应用程序的 config 目录中找到的 mautic.php 文件中添加您的 client id、client secret 和 callback url（对于OAuth2）或 username 和 password（对于基本身份验证）。

授权

此库仅支持OAuth2和基本身份验证。对于OAuth2，您需要创建OAuth2客户端才能使用API。

注册应用程序

为了将您的应用程序注册到Mautic，请ping此URL，这是一个一次性注册。

http://your-app/mautic/application/register

使用方法

在您的控制器中添加Mautic外观。

use Mautic;

向Mautic发送请求（示例）

在Mautic中创建一个新的联系人。

$params = array(
    'firstname' => 'Prince',
    'lastname'=> 'Ali Khan',
    'email' => 'princealikhan08@gmail.com'
);

Mautic::request('POST','contacts/new',$param);

获取所有联系人的列表

Mautic::request('GET','contacts');

获取一个唯一的联系人

Mautic::request('GET','contacts/1');
//where 1 is unique id for a contact.

删除一个联系人

Mautic::request('Delete','contacts/1/delete');

以及Mautic支持的更多端点。

Mautic支持的端点列表。

联系人

[
    "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/{id}"
]

活动

[
    "campaigns",
    "campaigns/{id}",
    "campaigns/contact/{id}/add/{leadId}",
    "campaigns/contact/{id}/remove/{leadId}"
]

数据

[
    "data",
    "data/{type}",
]

电子邮件

[
    "emails",
    "emails/{id}",
    "emails/{id}/send",
    "emails/{id}/send/lead/{leadId}"
]

表单

[
    "forms",
    "forms/{id}"
]

页面

[
    "pages",
    "pages/{id}"
]

点

[
    "points",
    "points/{id}",
    "points/triggers",
    "points/triggers/{id}"
]

报告

[
    "reports",
    "reports/{id}"
]

段

[
    "segments",
    "segments/contact/{id}/add/{leadId}",
    "segments/contact/{id}/remove/{leadId}"
]

用户

[
    "roles",
    "roles/{id}",
    "users",
    "users/{id}",
    "users/list/roles",
    "users/self",
    "users/{id}/permissioncheck",
]

有关所有可自定义参数的信息，请参阅文档。

gentor / laravel-mautic-api

维护者

详情