BaaS@rakuza ドキュメント

クイックスタート(JavaScript)

このページでは、BaaS@rakuza SDK for JavaScriptを利⽤するための手順を説明します。

ヒント

BaaS@rakuza SDK for JavaScriptはWebブラウザ、WebView（iOS・Android）、Node.js、React Nativeでの動作をサポートしています。使用できるバージョン等は動作環境を参照してください。

はじめに

  • サンプルコードの非同期処理はasync/awaitを使用しています。 async/awaitの詳細はこちらopen in new windowを参照ください。
  • サンプルコードはJavaScriptで記述していますが、TypeScriptもサポートしています。詳細はTypeScriptのサポートを参照してください。

インストール

NPM (推奨)

BaaS@rakuza SDK for JavaScriptではNPMを利用したインストール方法を推奨します。NPMを利用すれば、Webpackなどのモジュールバンドラーと組み合わせたり、Node.jsでSDKを使用できるなどの利点があります。

以下はNPMのインストールコマンドです。このコマンドをプロジェクトのルートディレクトリで実行してください。

npm i baasatrakuza -S

ES Module

Webpackなどのモジュールバンドラーを利用していたり、ES Moduleに対応しているブラウザ上では、ES ModuleとしてJavaScript SDKを参照することができます。

import RKZ from 'baasatrakuza'

Node.js

Node.jsでは、require関数でJavaScript SDKを参照してください。

const RKZ = require('baasatrakuza')

ブラウザ (scriptタグ)

JavaScriptファイルをscriptタグで読み込むことも可能です。scriptタグで読み込んだ場合は、RKZという名前のグローバル変数が登録されます。

CDN(UNPKG)からJavaScriptファイルを直接読み込むことも可能です。以下の場合、最新のJavaScript SDKがダウンロードされます。

<script src="https://unpkg.com/baasatrakuza"></script>

初期化処理

BaaS＠rakuza を利用する際には、RKZのインスタンスを利用します。以下の処理をアプリ起動時におこなうことで、BaaS@rakuzaのAPIを利用することが出来るようになります。

SDKを初期化する

ここでは BaaS＠rakuza を使用する上で重要なRKZの初期化を説明します。 BaaS@rakuzaではRKZの初期化は最初に呼び出される画面で行う事を推奨していますが、どの場所で初期化を行っても構いません。

以下は初期化のコード例です。SDKの初期化に成功しました！がアラートで表示されたら初期化成功です。

async function main() {
  RKZ.config.appAuthUsername = '<配布したアプリ認証ID>'
  RKZ.config.appAuthPassword = '<配布したアプリ認証パスワード>'
  try {
    await RKZ.init('<配布したテナントキー>')
    alert('SDKの初期化に成功しました！')
  } catch (error) {
    alert('SDKの初期化に失敗しました。', error)
  }
}



以上でBaaS@rakuza SDK for JavaScriptを利⽤する準備が完了しました。