カミハヤMAのAPIについて
本記事では、カミハヤMAのAPIについて説明します。
目次
１．はじめに
２．カミハヤMAのAPIについて
３．最後に
１．はじめに
カミハヤMAには、豊富なAPIが用意されています。提供されているのはREST形式のWeb APIです。出力形式はJSON形式です。
エントリポイントは、https://your-kamihaya.com/apiです。your-kamihaya.comの部分は、ご利用されてるインスタンスURLに読み替えてください。
対応している認証方式は、Basic認証とOAuth2認証の2つです。
２．カミハヤMAのAPIについて
カミハヤMAのAPIですが、管理画面で行えることのほとんどがAPI経由でも行えるのが特長となります。
（詳しくはhttps://developer.mautic.org/#rest-apiを参照ください。）
API設定方法ですが、歯車アイコン＞設定＞API設定から設定できます。
【API設定画面】
・APIを有効化しますか？を「はい」にします。
・Basic認証によるAPIリクエストを利用する場合には、HTTP Basic認証を有効にしますか？を「はい」にします。
（Basic認証で用いる資格情報は、カミハヤMAのログインユーザーのユーザー名とパスワードを使用します。）
・アクセストークン存続時間とリフレッシュトークン持続時間に値を設定します。
カミハヤMAの認証にはBasicの他にもOAuth2が用意されています。
カミハヤMAのOAuth2のグラントタイプ（アクセストークンの発行方法）ですが、Authorization code grantとClient credentials grantに対応しています。
OAuth2の場合は、APIを有効化しますか？を「はい」にした後、APIクレデンシャルの設定が必要です。
APIクレデンシャル設定方法ですが、歯車アイコン＞APIクレデンシャルから設定できます。
【APIクレデンシャル（アプリケーション）画面】
※下記のクライントID・クライアントシートは一時的に作成したものであり設定は削除されています。
①画面右上にある「新規」ボタンをクリックします。
②認証プロトコルがOAuth2になっていることを確認します。
③任意のクレデンシャル名を入力します。
④リダイレクトURIの設定は必要としない場合も入力必須項目となっていますので、その場合は適当なURLを入力してください。
⑤画面右上にある「適用」ボタンをクリックします。
⑥画面にクライントIDとクライアントシークレットが表示されます。これは、ClientのシステムからAuthorizationCodeとともにAuthorizationServerへ引き渡す必要があるためメモ帳などにコピーして控えておきます。
では、参考までにAPIテストツールであるPostmanを使ってClient credentials grantによるOAuth2を用いてAPI接続テストをしてみましょう。
Postmanは無料でサインアップできますので、事前にサインアップが完了していることを前提としています。
【Postman設定画面例】
※下記のアクセストークンは一時的に作成したものであり設定は削除されています。
①PostmanのWebサイトへアクセスしてログインします。
②画面左上にあるWorkspacesをクリックした後、My Workspaceをクリックします。
③右フレームのOverviewタブの右横にある＋をクリックします。
④Authorizationタブをクリックします。
⑤TypeのプルダウンメニューからOAuth2.0をクリックします。
⑥Grant TypeのプルダウンメニューからClient Credentialsをクリックします。
⑦Access Token URL にhttps://your-kamihaya.com/oauth/v2/tokenと入力します。
⑧ClientIDに【APIクレデンシャル（アプリケーション）画面】⑥で控えておいたクライントIDを入力します。
⑨Client Secretに【APIクレデンシャル（アプリケーション）画面】⑥で控えておいたクライアントシークレットを入力します。
⑩Get New Access Tokenのボタンをクリックします。
⑪Proceedボタンをクリックします。
⑫（例）登録されてるすべてのコンタクト情報を取得したければ、GETリクエストを選択してhttps://your-kamihaya.com/api/contactsを入力した後、Sendボタンをクリックします。
PostmanでBasic認証の場合は、⑤をOAuth2.0ではなくてBasic Authを選択してUsernameとPasswordにカミハヤMAのUsernameとPasswordを入力後に⑫をしていただくことになります。
３．最後に
いかがでしたでしょうか。
カミハヤMAには、多数のPluginが用意されていますが、接続先のアプリケーションとのPluginが無い場合やPluginの仕様では要件を満たせない場合には今回ご紹介したAPIを用いたシステム連携も視野に入れていただければと思います。
