メインコンテンツまでスキップ

ライセンスとProの有効化

Freeプランは、Perfex CRM Integration for WHMCSを継続的に運用するための、正式にサポートされた形態です。WHMCSからPerfexへ、クライアントとコンタクトをリアルタイムに一方向で同期します。この用途にライセンスキーは一切不要です。

Proライセンスは、それ以外の機能を有効にします。このページでは、購入、有効化、確認、削除について説明します。

Proで利用できるようになる機能​

Proで解放される機能日々の運用における意味
🔁 クライアントとコンタクトの双方向同期Perfexで修正した住所が、設定した競合ポリシーに従ってWHMCSへ反映されます
📄 請求書のミラーリングWHMCSの請求書が、明細、税行、ステータスとともにPerfexの顧客に表示されます
💳 支払いとトランザクションの同期WHMCSで支払われた請求書は、Perfex側のミラーもPaidに変わり、ゲートウェイとトランザクションIDが記録されます
🛒 注文の同期WHMCSの注文が、設定に応じてPerfexのリード、顧客へのメモ、または何もしない、のいずれかになります
🎫 サポートチケットの同期チケット、返信、ステータス変更が双方向で流れます。タイムシート向けにチケット単位のPerfexタスクを作成することもできます
🌐 サービスとドメインのパネルPerfexのすべての顧客プロフィールにWHMCSタブが追加され、そのクライアントのサービスとドメインが一覧表示されます
⏬ バックフィルウィザード新規のアクティビティだけでなく、既存のクライアント、請求書、サービス、ドメインを取り込めます
🗂️ 部門マッピング用ドロップダウンWHMCSのチケット部門とPerfexの部門の対応付けを、IDを入力するのではなく一覧から選んで設定できます

すべての機能を並べた比較はFreeとProの比較表にあります。

ライセンスはWHMCS側にのみ存在します

Perfex側のコンパニオンは無償で、キーを保持することはありません。プランを決めるのはWHMCSアドオンで、その内容をPerfexへ通知します。そのためPerfexの設定ページは、双方向同期が動作しているかどうかとその理由を表示できます。ライセンスキー自体がPerfexへ送られることはありません。

Proの購入: チェックアウトのオーバーレイ​

こちらが簡単な方法で、コピー＆ペーストはまったく不要です。

  1. いずれかの管理ページでアップグレードのリンクをクリックします。
    • WHMCS: Addons > Perfex CRM Bridge。Pro License Keyの入力欄の横にBuy a Pro licenceとして、またライセンスのチェックリスト行とProの案内ボックスにUpgrade to Proとして表示されます。
    • Perfex: Setup > WHMCS BridgeのWHMCS planパネルにあるUpgrade to Proボタンです。
  2. 安全なチェックアウトのオーバーレイが、今開いているページの上にそのまま表示されます。
  3. 購入手続きを完了します。
  4. 有効化は自動的に行われます。
    • WHMCSから開始した場合: チェックアウトの応答に含まれるライセンスキーが、設定フォームのPro License Key欄に書き込まれ、そのフォームが自動的に送信されます。保存処理でキーがライブ検証され、プランがProに切り替わり、Perfex側にも通知されます。これらはすべて同一のリクエスト内で完了します。
    • Perfexから開始した場合: キーは署名付きのブリッジチャネル経由でWHMCSインストール環境へ中継されます。WHMCSは何かを保存する前にキーをライブ検証し、Proを有効化して、最新のプラン状態をそのまま返します。そのためPerfexのプランパネルは、再読み込みなしでその場でProに切り替わります。Perfexがキーを保存することはありません。
  5. Proは直ちに有効になります。cronの実行を待つ必要も、何かを入力する必要もありません。
オーバーレイはあくまで補助機能です

ブラウザー拡張機能、厳格なコンテンツセキュリティポリシー、低速なネットワークなどでオーバーレイのスクリプトがブロックされた場合、リンクは従来どおりの動作となり、ホスティングされたチェックアウトページを新しいタブで開きます。何も壊れません。最後に以下の手動での貼り付けを行っていただくだけです。

有効化が完了する前にブラウザーが閉じてしまった場合​

キーは失われていません。安全策が2段階で用意されています。

  1. ページ上で確認する。 購入は成功したものの自動有効化を実行できなかった場合、キーは選択可能なフィールドとしてページ上に表示されます。Perfex側ではCopyボタンも付き、どこに貼り付ければよいかの具体的な案内も表示されます。購入済みのキーが、閉じたオーバーレイの中だけに存在する状態にはなりません。
  2. メールで確認する。 キーは購入時に必ずメールで送信され、決済プロバイダーのカスタマーポータルからも取得できます。タイミング悪くブラウザーがクラッシュした場合は、メールをご確認ください。

その後、以下の手動での手順に従ってください。

キーを手動で有効化する​

購入時のメール、カスタマーポータル、または別のWHMCS環境からライセンスを移す場合など、すでにキーをお持ちのときはこの手順をご利用ください。

  1. WHMCSでAddons > Perfex CRM Bridgeを開きます。
  2. Settings > Pro licenceまでスクロールします。
  3. Pro License Keyにキーを貼り付けます。キーはsk_で始まります。
  4. Save Settingsをクリックします。

有効化はこれだけです。実際に変更されたキーを保存すると、その場でライブ検証が実行されるため、ページが戻ってきた時点ですでにプランが表示されています。他に何かを押す必要も、cronの実行を待つ必要もありません。

バナーには、次の3つのうち必ず1つが表示されます。

バナー意味対応
🟢 緑 - 「Settings saved. Licence verified - your Pro plan is active...」ライセンスサーバーがキーを承認しました。ページのヘッダーとLicense / planのチェックリスト行はすでにProと表示され、Proの案内ボックスは消え、バックフィルウィザードが利用可能になっています。対応は不要です。完了しています。
🔴 赤 - 「Settings saved. The licence server rejected this key...」キーが拒否されました。メッセージにはサーバー側の理由が示されます。未知のキー、サブスクリプションの期限切れ、解約されたライセンス、有効化枠の使い切りなどです。購入時のメールに記載されたとおりに、文字の欠落や余分な文字なくキーが貼り付けられているか確認し、もう一度保存してください。
🟠 黄 - 「Settings saved. Could not reach the licence server...」承認でも拒否でもありません。現時点でサーバーからライセンスサービスに到達できませんでした。キーは保存されており、再試行は自動的に続きます。サーバーからapi.freemius.comへHTTPSで到達できるか確認し、Check licence nowをクリックしてください。その間は猶予期間によって保護されます。
色にかかわらず「Settings saved.」は常に事実です

設定はライセンス確認が実行される前にデータベースへ書き込まれます。したがって赤色のバナーが「保存に失敗した」という意味になることはありません。「保存は完了し、キーが拒否された」という意味です。フォームを入力し直す必要はありません。

ライセンス以外の設定を保存してもコストはかかりません

確認処理が実行されるのは、実際に変更されたライセンスキーだけです。同期の一時停止、注文の同期先の変更、チケット返信用管理者の編集では、ネットワーク通信は一切発生せず、バナーは単に「Settings saved.」と表示されます。

Check licence now​

Check licence nowボタンは、WHMCSのモジュールページ上部、Test ConnectionとRun Sync Nowの隣にあります。

このボタンは、1日1回の実行制限を無視して、保存済みのキーを直ちに再確認します。次のような場合にご利用ください。

  • ライセンスを更新または延長したばかりで、すぐにProへ戻したいとき。
  • 保存時のバナーが黄色で、その後ネットワークやファイアウォールの問題を解決したとき。
  • サポートへ問い合わせる前に、現在の状態を確認したいとき。

このボタンには、連打を防ぐための数秒間のクールダウンがあります。続けて2回押した場合、2回目は再度リクエストを送らずに「checked a moment ago」と応答します。数秒待てば、通常どおり再確認します。

キーがまったく保存されていない状態では、キーが空でありFreeプランであることを示す赤色のバナーが表示されます。この場合、サーバーからリクエストは送信されません。

有効状態の維持: 毎日の再確認と14日間の猶予期間​

キーが保存されると、WHMCSのcronが1日1回そのキーを再検証します。お客様側で行う作業はありません。

ライセンスサービスに到達できない場合でも、モジュールがProを無効にすることはありません。その状況は「拒否された」ではなく「判断できない」として扱われ、14日間の猶予期間の間はProが完全に動作したまま再試行が続きます。

知っておくと役立つ点が3つあります。

  • 猶予期間の起点は、最後に確認が成功した時点です。 最後の試行時点ではありません。ページに表示される残り日数は実際の残日数であり、再試行が失敗するたびにリセットされることはありません。
  • 明確な拒否があった時点で猶予は終了します。 ライセンスサーバーが、ライセンスは期限切れ、解約済み、または無効であると明示的に応答した場合、それは1つの回答であり、猶予は適用されません。ファイアウォールでライセンスのエンドポイントを遮断しても、失効したライセンスを生かし続けることはできません。
  • 猶予は延長するものであり、最初の有効化を代替するものではありません。 一度も確認されたことのないキーには、頼れる猶予がありません。ライセンスサービスに到達できない状態で新しいキーを貼り付けた場合、キーは保存され再試行されますが、確認が実際に成功するまでProは有効になりません。

ページヘッダーに表示されるプランの状態​

ヘッダーの表示意味
Free plan - no licence key set.キーがありません。Freeティアで正常に動作しています。
Pro license set - awaiting first verification.キーは保存されていますが、一度も確認されていません。Check licence nowをクリックしてください。
Pro active until YYYY-MM-DD (UTC)すべて正常です。
Pro active - lifetime licence有効期限のないライセンスです。
Pro (grace) - could not reach the licence server, retrying daily. Pro keeps working for N more day(s).一時的な障害です。現時点で支障はありません。
Free plan - this licence has expired.更新してからCheck licence nowをクリックしてください。
Free plan - this licence was cancelled.ライセンスが解約または返金されています。誤りである場合はサポートへご連絡ください。
Free plan - the licence key was rejected.キーが誤っているか、有効化枠を使い切っています。メッセージにはサーバー側の文言がそのまま表示されます。
Free plan - the licence server could not be reached and the grace period has run out.ライセンスのエンドポイントへの接続を修正してから、Check licence nowをクリックしてください。

同じ文言はセットアップチェックリストのLicense / planの行にも表示されるため、探し回る必要はありません。

有効化スロット​

WHMCS 1環境につき、ライセンスの有効化スロットを1つ消費します。モジュールは安定した識別子を一度だけ生成し、以後それを使い続けるため、再確認、再保存、別ドメインへのサイト移転を行っても2つ目のスロットを消費することはありません。

ライセンスがすでに上限数の環境で使用されている、という拒否メッセージが表示された場合は、不要になった環境からキーを削除してスロットを直ちに解放するか、上限数についてサポートへお問い合わせください。

キーを削除してFreeに戻す​

  1. WHMCSでAddons > Perfex CRM Bridge > Settings > Pro licenceを開きます。
  2. **Remove the stored key (revert to Free)**にチェックを入れます。
  3. Save Settingsをクリックします。

その結果、次のようになります。

  • キャッシュの状態にかかわらず、環境は直ちにFreeへ戻ります。Pro機能は停止します。
  • 有効化スロットが解放されるため、ライセンスを別の環境で有効化できます。
  • Perfex側にもダウングレードが通知されるため、WHMCS planパネルがその日いっぱいProと表示し続けることはありません。
サイトを移行または廃止する前にキーを削除してください

キーを削除しないままWHMCS環境を削除すると、その有効化スロットは消費されたままになります。キーの削除は5秒で済み、後日のサポートとのやり取りを省けます。

Proが終了したときにデータはどうなるか​

削除されるものは何もありません。Free環境では次のようになります。

  • クライアントとコンタクトの同期は、これまでどおり一方向で動作し続けます。
  • WHMCSは請求書、支払い、注文、サービス、ドメイン、チケットのイベントをキューに入れなくなります。制限は発生元の時点で適用されるため、蓄積されることも、無駄に再試行されることもありません。
  • すでにWHMCS向けにキューへ入っていたPerfex側の変更は、Outbound queueパネルに「Two-way sync requires Pro on the WHMCS side」という明確なメッセージとともに拒否され、再試行の後に最終的にデッドレターとなります。
  • すでに同期済みの内容はPerfexに残ります。顧客プロフィールのWHMCSタブは、最後に保存されたスナップショットを引き続き表示します。更新が止まるだけです。

有効なキーを再度有効化すれば、次のイベントからすべて再開されます。

ライセンスに関するトラブルシューティング​

症状原因対処
キーを保存しても何も起きないすでに保存されていたものと同じキーを貼り付けています。確認処理が動くのは変更されたキーの場合だけです。Check licence nowをクリックしてください。
毎回バナーが黄色になるサーバーからライセンスのエンドポイントへHTTPSで到達できません。WHMCSサーバーの外向きファイアウォールやプロキシで、api.freemius.comへのアウトバウンドHTTPSを許可してください。その後Check licence nowをクリックします。
キーは正しく見えるのに「The licence key was rejected」となる貼り付けが途中で切れているか、有効化枠を使い切っています。購入時のメールからキーを一度でコピーし直してください。キーは32文字で記号を含むことがあるため、一部を削らないでください。メッセージに導入数への言及がある場合は、スロットを1つ解放してください。
WHMCSがProと表示しているのにPerfexはFreeのままプランの状態がまだPerfexへ届いていません。WHMCSでCheck licence nowまたはTest Connectionをクリックしてください。どちらもその場でプランの状態をPerfexへ届けます。その後Perfexの設定ページを再読み込みします。
PerfexのプランパネルがUnknownと表示されるWHMCS側から一度も報告がない、または長期間報告がありません。WHMCSでTest Connectionをクリックし、Perfexのページを再読み込みしてください。Unknownのままの場合は、WHMCSのcronが停止しているか、両側のペアリングが解除されている可能性があります。

さらに詳しい内容はトラブルシューティングにあります。