Postman から OAuth 2.0 認証で Mautic REST API を利用する【事前準備】

#

Mautic API を久しぶりに使おうと思ったら完全に忘れていたので、記事に残しておきます。

執筆時点のバージョン

Mautic 側の準備

  • [設定>API設定] にアクセスする
    • 「API を有効化しますか?」を「はい」に
    • 今回はOAuth認証を使うので「HTTP Basic 認証を有効にしますか?」は「いいえ」のままで良い
  • [設定>APIクレデンシャル]にアクセス
    • 新規ボタンからクレデンシャルを作成
      • リダイレクトURIは https://app.getpostman.com/oauth2/callback に設定(通常アプリケーションごとに異なるURIです。PostmanでなぜこのURIなのかは、いまいちわかってない)
      • 作成すると、公開キーとシークレットキーが発行されます。

Postman 側で OAuth2 リクエストを作成

リクエストのたびにいちいち認証するのはめんどくさいので、まずコレクションを作成します

  • New ボタンから Collection を選択します
  • 作成したコレクションの編集画面を開き、Authorization タブを開きます
  • TYPE で OAuth 2.0 を選択し、「Get New Access Token」ボタンをクリックします。
  • 下記のように入力し「Request Token」ボタンをクリックします。
Grant Type Authorization Code (現在のMauticは authorization_code と refresh_token しか対応していません)
Callback URL https://app.getpostman.com/oauth2/callback
Auth URL https://mautic.test/oauth/v2/authorize (ドメインはお使いのMauticに合わせてください)
Access Token URL https://mautic.test/oauth/v2/token (ドメインはお使いのMauticに合わせてください)
Client ID Mautic で作成したクレデンシャルの公開キーを入力
Client Secret Mautic で作成したクレデンシャルのシークレットキーを入力
Scope なし(Mautic はまだスコープ未実装なんですよね…)
State CSRF対策用のナンスです。テキトーに設定してください。一応空でも動きます

情報が正しければ、Mauticのログイン画面で認証したあと、アクセストークンをゲットしつつPostmanに帰ってこれます。あとは、コレクション内で新しいリクエストを作成すればOKです。

Postmanのスクリーンショット:Mautic APIでキャンペーンの一覧を取得

以上


コメント欄を読み込み中