拡張アプリ ChatWork を公開しました

今年、2018年3月26日に公開された a-blog cms Ver.2.8ではより外部サービスと連携しやすい仕組みを用意しています。そこで今後いくつかの連携機能をa-blog cmsの本体とは別に拡張アプリという形で配布することにしました。 その第4弾として今回は 拡張アプリ「ChatWork」を用意しました。拡張アプリ「ChatWork」を使うとお問い合わせフォームなどから送信された内容を ChatWork に通知することができます。たとえばフォームから「資料請求」などがあれば「資料請求がありました。」などの簡単なメッセージや、メールの本文をそのまま、好きなルームに通知できます。

ダウンロード

ダウンロード

利用するためにはダウンロード後、/extension/pluginsに設置してください。

使い方

以下の3つのステップで a-blog cms と ChatWork を連携します。

  1. ChatWorkへの登録
  2. API トークン の取得
  3. a-blog cmsの拡張アプリ ChatWork に APIトークン を登録

1. ChatWork への登録

ChatWork のアカウントをお持ちでない方は下記のURLにてアカウントを作成しましょう。 https://www.chatwork.com/

2. API トークン の取得

https://www.chatwork.com/service/packages/chatwork/subpackages/api/token.php

3. a-blog cmsの拡張アプリ ChatWork に API トークンを登録

管理ページ > 拡張アプリより「拡張アプリ管理」のページに移動します。そのページより下の図のように ChatWork をインストールします。

インストール完了後は、管理ページ > フォーム > 連携したいフォームID より ChatWork の管理ページに移動します。その後、「APIトークン」という項目がありますので、その項目に先ほど覚えておいた APIトークン を入力します。 また「ルームID」には、下記のURLの*****の部分を入力します。

https://www.chatwork.com/#!rid*****

これでa-blog cmsと ChatWork を連携させる準備は整いました。あとは先ほどの設定がされたフォーム「お問い合わせフォームなど」に移動し普段通り情報を入力します。

お問い合わせ完了後、以下のようなメッセージがChatWorkに通知されていれば成功です。

注意

config.server.phpでHOOKを有効にしておく必要があります。

define('HOOK_ENABLE', 1);

拡張アプリの今後の配布について

拡張アプリは今後 applepleのGitHubのページに公開していく予定です。 またGitHubに公開されているアプリは下の拡張アプリ一覧ページからダウンロードできるようになりますのでよかったら訪れてみてください。

拡張アプリ一覧ページ

エントリーのユニット設定

[ユニット設定]画面では、エントリー作成画面で入力するユニットの設定ができます。この設定により、新規にエントリーを作成する時のユニットの設定をあらかじめ決めておいたり、ユニットを追加する時のユニットの設定を決めておくことができます。入力する内容の形式が決まっている場合にユニット設定をしておけば、毎回ユニットの種類を自分で設定しなくてもよくなります。

[ユニット設定]は、管理者のみ設定可能です。編集者／投稿者／読者には[コンフィグ管理]画面は表示されません。

[ユニット設定]画面を表示するには、管理ページ > コンフィグ > ユニット設定 へ進みます。

管理ページ > コンフィグ > ユニット設定

[ユニット設定]画面

ユニットを追加・削除する

ユニット編集画面では、エントリー作成時に使用する「テキスト」「画像」などの各ユニットボタンをクリックした時に表示される情報の入力枠を編集できます。これらは 管理ページ > コンフィグ > 編集設定 の「ユニット追加ボタン」で追加したものが表示され、編集できます。以下、各ユニットに共通の追加・削除について説明します。

（1）ユニットを追加するには、[テキスト][画像]などのボタンをクリックします。削除するには、各ユニット右側の[削除]ボタンをクリックします。

（2）[保存]ボタンをクリックします。

エントリー新規作成時のユニットの初期設定をする

エントリーを新規に作成する時の、入力画面のユニットの設定をおこないます。

（1）[ユニット設定]画面の[新規記事作成]項目にユニットを追加・削除し、初期設定として表示させたいユニットを設定します。それぞれのユニットの詳細設定も可能です。ここでは、例として以下の図のように設定しました。

（2）[保存]ボタンをクリックします。

（3）[エントリー作成]ボタンをクリックします。

（4）エントリー作成画面で、先ほど[ユニット設定]画面で設定したユニットが初期状態として表示されるようになります。

エントリー作成画面の初期状態

エントリー作成画面の初期状態

ユニット新規追加時の初期設定をする

エントリー作成画面で、新しくユニットを追加する時の初期設定も可能です。

（1）[ユニット設定]画面の各ユニット（テキスト、画像など）で入力枠の追加・削除などの設定をおこない、[保存]ボタンをクリックします。

（2）エントリー作成画面の[追加]で各ボタンをクリックすると、手順（1）で設定したユニットが初期状態として表示されるようになります。

拡張アプリ Zoho を公開しました

今年、2018年3月26日に公開された a-blog cms Ver.2.8ではより外部サービスと連携しやすい仕組みを用意しています。そこで今後いくつかの連携機能をa-blog cmsの本体とは別に拡張アプリという形で配布することにしました。 その第5弾として今回は 拡張アプリ「Zoho」を用意しました。拡張アプリ「Zoho」を使うとお問い合わせフォームなどから送信された入力内容を Zoho CRM 上に蓄積することができます。

ダウンロード

Zoho for a-blog cms

以下の3つのステップでa-blog cmsとzohoを連携します。

  1. Zoho CRMの登録
  2. 認証トークンの取得
  3. a-blog cmsの拡張アプリ zoho に認証トークンを登録

1. Zoho CRMの登録

まずはZoho CRM に登録します。機能は制限されますが、無料版がありますのでアカウントがない人はまずは無料版を使ってみましょう。

2. 認証トークンの取得と登録

下記のURLより、クライアントIDを追加します。 https://accounts.zoho.com/developerconsole

設定後は、先ほど追加したクライアントに対して、セルフクライアントの設定をします。

スコープにはZohoCRM.modules.allと入力してください。期限は何分でも構いませんが、その期限内にoAuth認証を済ませる必要があります。入力をすませると、oAuth認証に必要なgrantトークンが表示されるはずです。このトークンを覚えておきましょう。

configファイルの設定

configuration.propertiesとoauth_configuration.propertiesに設定を追記します。 場所は、extension/plugins/Zoho/vendor/zohocrm/php-sdk/src/resources にあります。

configuration.properties

apiBaseUrl=www.zohoapis.com
apiVersion=v2
sandbox=false
applicationLogFilePath=./
currentUserEmail={Zohoに登録したメールアドレス}

oauth_configuration.properties

client_id={取得したClientID}
client_secret={取得したClient Secret}
redirect_uri={リダイレクトURL}
accounts_url=https://accounts.zoho.com
token_persistence_path=./
access_type=offline
persistence_handler_class=ZohoOAuthPersistenceHandler

3. a-blog cmsの拡張アプリ zoho に認証トークンを登録

管理ページ > 拡張アプリ より「拡張アプリ管理」のページに移動します。そのページより下の図のようにZohoをインストールします。

インストール完了後は、先ほどのgrantトークンを「a-blog cmsの管理画面 > 拡張メニュー > Zoho」より入力します。zohoの登録で使用しているメールアドレスもここで入力しておく必要があります。 入力後は設定を保存し、「認証」ボタンをクリックします。無事に認証ができると、下の図のように「認証済み」というラベルが表示されるはずです。

注意

config.server.phpでHOOKを有効にしておく必要があります

define('HOOK_ENABLE', 1);

Zoho 拡張アプリの設定

先ほどのgrantトークンをa-blog cmsの管理画面 > 拡張メニュー > Zoho より入力します。zohoの登録で使用しているメールアドレスもここで入力しておく必要があります。

拡張アプリZohoの使い方

「管理画面 > フォーム管理 > 設定したいフォームID」よりフォームに対するZohoの設定を行うことができます。 a-blog cmsのForm内のキーに対してZoho側のキーを紐づけることで、a-blog cms側のフォームの送信結果を処理してzohoに送信することができます。Zoho側のキーは下の図のようにラベル名に対応しています。

以下3つの作業が必要になります。

  1. Formの権限設定
  2. Zohoのカスタムフィールドの設定
  3. lookupIdの関連付け

1. Formの権限設定

フォームIDごとに、Zohoのどのモジュールに対してInsert（データの挿入）及びUpdate（データの更新）ができるかを設定できます。例えば、下の画像の場合、CustomModule1のモジュールに対してInsert権限があり、Contactsのモジュールに対してはUpdate権限があります。またInsertやUpdate時に「会員番号」がユニークキーとして処理が実行されます。

2. Zohoのカスタムフィールドの設定

次は、カスタムフィールドの設定です。ここではa-blog cmsのフォーム側の変数とZoho側のカスタムフィールドの紐付けを行います。例えば、一番最初の列では、a-blog cms側のカスタムフィールドemailの項目はZoho側のLeadsモジュールとCustomModule1モジュールのEmailに対応しています。

この際に、新規レコードに追加したい変数は、「Insert」にチェックし、既存レコードの更新を行いたい変数については「Update」にチェックを入れてください。

3. lookupIdの関連付け

またZoho側に登録したデータどうしをlookupIDを通して紐づけることができます。 例えば、商品に対してその商品を誰が買ったのかをルックアップIDを使って以下のように紐づけます。 ルックアップIDにはそのルックアップIDに使用されているzoho側のラベル名を登録します。

Zoho と a-blog cms 連携カスタマイズについてのレクチャーを行うことも可能です。

ご希望の方は下記のURLよりお問い合わせください。

https://www.a-blogcms.jp/contact/