👨‍💻

(パートナー用)チャネルトーク連携開発方法

自社で提供しているウェブビルダーサービスでチャネルトークを提供したいという企業様向けの連携方法説明となります。

【連携手順】

  1. 有料版へのアップグレード(スタンダード or プロ):チャネルと連携を行うためにはAPIの呼び出しが必要なため、有料版でのご利用が必要となります。(無料トライアル期間中もAPIの呼び出しが可能です。継続しての提供をご希望の方は弊社へご連絡ください)

    チャネルの設定 > 支払い管理 > プランの管理 よりアップグレード可能です

  2. チャネルの"Plugin Key"および"Access Secret"を貴社サービスのユーザーが記入する欄を貴社アドミンページに作成する(下記参照)

    <参照>貴社ユーザーが入力する"Plugin Key"および"Access Secret"はこちらから確認できます👇

    image

3. 貴社サービスで弊社のコードを呼び出せるような環境を整えておくこと

  • 基本コードの場合
<!-- Channel Plugin Scripts -->
<script>
  (function() {
    var w = window;
    if (w.ChannelIO) {
      return (window.console.error || window.console.log || function(){})('ChannelIO script included twice.');
    }
    var d = window.document;
    var ch = function() {
      ch.c(arguments);
    };
    ch.q = [];
    ch.c = function(args) {
      ch.q.push(args);
    };
    w.ChannelIO = ch;
    function l() {
      if (w.ChannelIOInitialized) {
        return;
      }
      w.ChannelIOInitialized = true;
      var s = document.createElement('script');
      s.type = 'text/javascript';
      s.async = true;
      s.src = 'https://cdn.channel.io/plugin/ch-plugin-web.js';
      s.charset = 'UTF-8';
      var x = document.getElementsByTagName('script')[0];
      x.parentNode.insertBefore(s, x);
    }
    if (document.readyState === 'complete') {
      l();
    } else if (window.attachEvent) {
      window.attachEvent('onload', l);
    } else {
      window.addEventListener('DOMContentLoaded', l, false);
      window.addEventListener('load', l, false);
    }
  })();
  ChannelIO('boot', {
    "pluginKey": "YOUR_PLUGIN_KEY" // (手順の2.で貴社ユーザに登録されたPlugin key)
  });
</script>
<!-- End Channel Plugin -->

  • 会員情報を連携させる場合
<!-- Channel Plugin Scripts -->
<script>
  (function() {
    var w = window;
    if (w.ChannelIO) {
      return (window.console.error || window.console.log || function(){})('ChannelIO script included twice.');
    }
    var d = window.document;
    var ch = function() {
      ch.c(arguments);
    };
    ch.q = [];
    ch.c = function(args) {
      ch.q.push(args);
    };
    w.ChannelIO = ch;
    function l() {
      if (w.ChannelIOInitialized) {
        return;
      }
      w.ChannelIOInitialized = true;
      var s = document.createElement('script');
      s.type = 'text/javascript';
      s.async = true;
      s.src = 'https://cdn.channel.io/plugin/ch-plugin-web.js';
      s.charset = 'UTF-8';
      var x = document.getElementsByTagName('script')[0];
      x.parentNode.insertBefore(s, x);
    }
    if (document.readyState === 'complete') {
      l();
    } else if (window.attachEvent) {
      window.attachEvent('onload', l);
    } else {
      window.addEventListener('DOMContentLoaded', l, false);
      window.addEventListener('load', l, false);
    }
  })();
  ChannelIO('boot', {
    "pluginKey": "YOUR_PLUGIN_KEY", // (手順の2.で貴社ユーザに登録されたPlugin key)
    "userId": "YOUR_USER_ID", //fill with user id
    "profile": {
      "name": "YOUR_USER_NAME", //fill with user name
      "mobileNumber": "YOUR_USER_MOBILE_NUMBER", //fill with user phone number
      "CUSTOM_VALUE_1": "VALUE_1", //any other custom meta data
      "CUSTOM_VALUE_2": "VALUE_2"
    }
  });
</script>
<!-- End Channel Plugin -->

4. 下のガイドを参考に、API認証キーを発行し、"Access Key"と"Access Secret"をコピーしておいてください。

🗝
Open APIの利用方法

5 . 貴社サービスのユーザーが、上記で作成をお願いしたアドミンページにて、チャネルの"Plugin Key"および"Access Secret"を登録したら、Partner General APIを叩いて登録されたチャネルのアカウントが貴社サービス経由で生成されたアカウントであることを登録してください。

(⚠️チャネルトークとパートナー契約がある場合、こうすることでレベニューシェアが可能になります)

HTTPリクエスト
リクエストヘッダー

Accept: application/json

X-Access-Key: {Access Key}

X-Access-Secret: {Access Secret}

その他 Partner General APIのドキュメントはこちらを参考にしてください👇

【貴社サービスユーザーへのガイド】

  • チャネルの設定 > チャットの導入および設定 > チャットボタンのインストール から"Plugin Key"及び"Access Secret"をそれぞれコピーし、貴社サービスのアドミン画面に入力するようガイドして下さい
  • Plugin Keyはチャネルを動かすためのキーであり必須です、Access Secretは貴社サービスからの流入であることを確認できるようにするためのキーです(なくても駆動しますが、レベニューシェアの際には必須です)

image