MAやMauticの役立つノウハウや情報をお送りします!
×
【Mautic】他システムとの連携方法(REST API : OAuth2編) | Mautic | マーケティングオートメーションツールを始めるなら | custom journey
B to Bマーケティングオートメーションツールを始めるならCUSTOM JOURNEY。MAオープンソースのMauticとAWSで日本語環境を用意しました。
BtoBマーケティングオートメーション,オープンソース,mautic,marketing automation,Customer journey map,custom journey
16746
single,single-post,postid-16746,single-format-standard,ajax_fade,page_not_loaded,,qode-theme-ver-8.0,wpb-js-composer js-comp-ver-4.9.2,vc_responsive

【Mautic】他システムとの連携方法(REST API : OAuth2編)

businessman-3075837_1280

【Mautic】他システムとの連携方法(REST API : OAuth2編)

こんにちは。 CUSTOM JOURNEY運営局の山本です。

Mauticと外部のシステムを連携したいという方は結構いるのではないでしょうか?

Mauticとは別にCRMツールや独自の基幹システムをすでに運用している方も多いかと思います。そういう場合はMauticと連携できたら便利ですよね。

そこで今回は外部からMauticのデータを扱う方法を紹介します。

  
 

Mautic との連携方法

Mauticと外部システムで連携する方法は主に3つあります。

1. プラグイン
2. REST API
3. Webhook

今回は2のREST APIを使った外部連携する方法です。

REST API の中でも複数の方法があります。

2-1. OAuth 1a
2-2. OAuth 2
2-3. Basic認証

一般的に「OAuth 2.0」が多いですかね。今回もその「OAuth 2.0」を使った方法を紹介します。

 

目次

  1. Mauticの設定
  2. PHPライブラリの導入
  3. PHPファイルの作成
  4. アクセストークンの取得
  5. データの取得

 

1. Mauticの設定

まずはMauticの管理画面にて設定を行う必要があります。

管理画面の右上の歯車マークをクリックして「設定」をクリックします。
設定の中に「API設定」というのがありますので、そちらをクリックします。
スクリーンショット 2018-04-04 18.23.44

ここで「API を有効化しますか」を『はい』に変更します。
ちなみに「HTTP Basic認証を有効にしますか」は先ほど紹介した「2-3. Basic認証」です。今回はこちらは変更しません。

スクリーンショット 2018-04-04 18.26.03

「アクセストークン」と「リフレッシュトークン」の有効期限は今回はそのままで進めます。

上記設定を保存すると、「設定」のメニューに「API クレデンシャル」というのが追加されます。

スクリーンショット 2018-04-04 18.27.59

そちらをクリックします。

スクリーンショット 2018-04-04 18.29.49

右上の新規をクリックします。

スクリーンショット 2018-04-04 18.32.20

「認証プロトコル」にて『OAuth 2』を、名前は適当なアプリケーションの名前、リダイレクトURIに任意のURLをいれます。

スクリーンショット 2018-04-06 16.58.11

登録すると「公開キー(clientKey)」「シークレットキー(clientSecret)」が発行されます。あとで利用しますのでコピーしておいてください。

以上でMauticの管理画面上での設定は終わりです。

 

2. PHPライブラリの導入

REST APIを利用するにあたってMautic側でライブラリを用意しています。

以下のようにcomposerでインストールするか

以下よりダウンロードしてきます。

https://github.com/mautic/api-library/

※composerでインストールしたものと上記からダウンロードできるが微妙にファイルの中身が違うようです。。自分はcomposerでインストールしてますので、そちらの解説になります。

 

3. PHPファイルの作成

次にアクセストークンを取得するために、先ほどのモジュールを使った簡単なPHPのファイルを作成します。

こちらのサイトのコードを参考にしました。

・「/vendor/autoload.php」はライブラリを導入したパスに変更してください。
・「baseUrl」はMauticの管理画面のURLを入力ください。(※自分の環境だと最後の/があるとNGでした、、)
・「clientKey」「clientSecret」は先ほどコピーした内容
・「callback」は先ほどアプリケーション作成時に『リダイレクトURI』で入力したもの

こちらを保存して、「callback」のURLの箇所にあげてください。

4. アクセストークンの取得

さて、いよいよアクセストークンを取得します!
先ほど作成してあげたファイルにアクセスしてください!

スクリーンショット 2018-04-06 17.16.09

するとリダイレクトされて、ログイン画面が出てきます。
URLは「https://xxx.com/oauth/v2/authorize_login」かと思います。

そこでログインすると・・・

スクリーンショット 2018-04-06 17.17.28

このような接続許可の画面が出てくるので、「許可」をクリックします。

するとcallbackのURLにリダイレクトされて以下のようにアクセストークンなどがGETできるかと思います!!

スクリーンショット 2018-04-06 17.20.15

ではこのアクセストークンを使って、データを取得してみましょう!

 

5. データの取得

ライブラリを使って取得する方法ももちろんありますが、ここでは試しに簡単にURLアクセスだけ(GET)で取得してみましょう。

例えば、コンタクトIDが「2」のユーザーデータを取得してみます。

こちらにアクセスすると・・・

スクリーンショット 2018-04-06 17.30.49

こんな感じで情報を取得できました! もちろん取得だけではなくて新しくデータを作ったり、更新、削除も可能です!

詳細は以下のドキュメントを参考ください。
https://developer.mautic.org/#rest-api

 

うまくいかないとき

もしうまくいかない時は以下のトラブルシューティングを試してみてください。
https://mautic.org/docs/en/tips/troubleshooting.html

自分の場合うまくいかないので上記トラブルシューティングにあるキャッシュクリアしたらいけたということもありました・・(何時間もハマるやつ・・・)

 

最後に

いかがでしょうか? REST API を使ってMauticのデータを簡単に外部から自由にいじることができるのがわかったかと思います。これで他のシステムとの連携も比較的容易にできるのかと思います。

もしほかシステムとの連携を考えている人がいましたら、是非ご参考ください!

では!


★ Mauticの導入でお悩みなことはありませんか?

Mautic導入の相談なら弊社サービスCustom Journeyに相談ください。
大手クライアントへの導入・運用実績もあります。

【MAUTIC導入事例紹介してます!!】
パーソルキャリア㈱(旧:㈱インテリジェンス)さまの導入事例
こちらをクリック!