Web アプリへの SDK の導入

プロジェクトの設定

以下の手順で、Kii Cloud SDK をあなたのプロジェクトに追加します。

  1. Kii Cloud SDK の ZIP ファイルをダウンロードします。

    まずはライブラリーをダウンロードします。開発者ポータル(https://developer.kii.com)にログインし、"ダウンロード" ページで SDK のリンクをクリックするとライブラリーがダウンロードされます。

  2. Kii Cloud SDK の ZIP ファイルを展開します。

    SDK を展開すると、KiiSDK.min.js、KiiSDK.js という 2 つのファイルがあります。どちらか一方を選択し、モバイルアプリを構成する HTML ファイルなどとともに公開します。

    いずれも同じ機能を持っていますが、KiiSDK.min.js はソースから空白などの情報が取り除かれています。リリース時にはサイズの小さな KiiSDK.min.js を、開発時にはソースが参照可能な KiiSDK.js を利用できます。

  3. HEAD タグ内で Kii Cloud SDK を読み込ませます。

    SDK の JS ファイルが起動時に読み込まれるように設定します。SDK の公開ディレクトリは適宜変更してください。

    <head>
      <script type="text/javascript" src="../js/KiiSDK.js"></script>
      ...
    </head>
    
  4. onLoad ハンドラー内で初期化メソッドを AppIDAppKey を指定して呼びます。

    <head>
      ...
      <script type="text/javascript">
    
        window.onload = function() {
          // Initialize the Kii Cloud SDK. Call this method before any other Kii SDK API calls.
          Kii.initializeWithSite("___APPID___", "___APPKEY___", KiiSite.JP);
    
          // Initialize other components.
          ...
        };
      </script>
    </head>
    

    ___APPID___ には開発者ポータルにて取得した AppID を、___APPKEY___ には任意の値を設定してください。

    KiiSite は、開発者ポータルで指定したサーバー設置場所に合わせ KiiSite.USKiiSite.JPKiiSite.CN3KiiSite.SG、または KiiSite.EU のいずれかを設定してください。

    アプリ分析の機能を使用する場合、第 4 引数にデバイス ID を指定する必要があります。実装方法については アプリ分析のサンプルコード をご覧ください。

AppID をクライアントサイドのスクリプトに埋め込んでも、アクセス制御を正しく行えば安全性は確保できます。詳細は、セキュリティ をご覧ください。

Version 2.1.12 より jQuery の利用が任意となり、Kii Cloud SDK が jQuery の有無にかかわらず利用できるようになりました。
なお Kii Cloud SDK では、下記の順番でどの XMLHttpRequest を利用するかを自動的に選択します。
1. jQuery が定義されている場合、SDK は jQuery.ajax を利用します。
2. XMLHttpRequest が定義されている場合、SDK は XMLHttpRequest を利用します。
3. Titanium が定義されている場合(Kii Cloud SDK を Titanium で利用する場合)、SDK は Titanium.Network.HTTPClient を利用します。