どのパッケージを使えばいいですか？

BoltzEngine には、複数のサービスが存在し、用途に応じて使用するパッケージが異なります。

各パッケージの概要

主に以下のようなサービスが存在しています。これらは必要に応じてインストールするパッケージが異なります。

サービス	説明
BoltzEngine	製品本体です
BoltzMessenger	管理画面、DB、アプリ、APIがセットになった製品です
HTTP API	REST APIで通知を行うためのサービスです
CSVコマンド	CSVファイルを使って通知を行うためのコマンドです

導入のヒント

それぞれのサービスがどういった用途で使えるかを説明します。どれか1つだけ利用しても構いませんし、複数のサービスを同時に使うこともできます。

任意のメッセージを管理画面から通知したい

任意のメッセージを全体または特定のグループに対して、管理画面から通知したい場合は、BoltzMessenger がお使いいただけます。管理画面では、通知先の選択、予約配信などが行えますし、アプリから利用可能な Messenger 用の API も用意しています。

また、Messenger API を使いやすくしたSDKや、受信専用のアプリもパッケージに含んでいますので、設定すればすぐに利用可能ですし、ソースコードもお渡ししますのでカスタマイズして頂いても構いません。

BoltzMessenger の詳しい機能は、BoltzMessenger 製品ページを参照ください。

ただし、管理者がメッセージを送ることを目的としているため、特定の1端末へ通知を行うといったことはできません。

CSV ファイルを使ってバッチ処理で通知したい

他システムで何らかの処理を行い、その結果で通知が必要な端末へ通知を行う場合、 CSV ファイルにトークンとメッセージを書き出しておけば、boltz-csv-queue コマンドでファイルに書かれた内容を使って、まとめて通知を行うことができます。CSV ファイルは、以下を1行に記述し、複数の端末へ通知を行う場合は2行目、3行目と続けます。

トークン
有効期限(秒)
通知するメッセージ
追加パラメータ、バッジなど(なければ省略可)

以下は記述例です。

139053fd0ea90634699568ef0d9d2983a20b45dc4a4dee8dc8b648caa5a3aa558,1500,メッセージ1
29ed6251c87b1e4f8d0a05b2aab6b850cf4034d24a82d7f555917d229f86a7b38,1500,メッセージ2
37a7e3f3ee9cbd74d194267980e18755ac579d1ea4ee1b206ac7c8533518e902f,300,メッセージ3

CSV を使った送信は、コマンドを実行した時に行われるため、定期的に実施したい場合はスケジューラなど別のシステムを使った連携が必要です。また、BoltzEngine には実装されていても、CSV コマンドでは使えないものが存在します。

別システムからAPIを使って通知したい

API インターフェイスとして gRPC や Go の net/rpc が使える場合は、BoltzEngine 本体の機能がそのまま利用できます。これは Engine が持つ全ての機能をサポートしているため、制限はありませんし、リクエストを送った時点ですぐに通知を行うことができます。

ただしAPIを利用する側の実装は、お客様が行なっていただく必要があります。 gRPC と net/rpc の使い方は、BoltzEngine の入力 API の種類はどのようなものがあり、どのような違いがありますかを参照ください。

API を使いたいけど gRPC や net/rpc は難しい

gRPC が対応していない言語から API を実行したい場合など、そういった用途には、REST 形式の HTTP API も用意しています。

これは内部的には Engine 本体の API を実行しており、基本的には全て対応していますが、リリース直後の機能などは一部未対応の場合もあります。

導入が必要なパッケージ

上記それぞれの場合で、必要なパッケージを説明します。

BoltzMessenger を使う場合

BoltzMessenger には、以下のパッケージをインストールしてください。

BoltzEngine
BoltzMessenger Gateway
BoltzMessenger Admin
BoltzMessenger Web

CSV コマンドを使う場合

CSV コマンドを使うためには、以下のパッケージをインストールしてください。

BoltzEngine
Boltz Tools (Windows 版の場合はデフォルトでインストールされます)

BoltzEngine本体のAPIを使う場合

この場合は BoltzEngine だけあれば利用できます。

BoltzEngine HTTP APIを使う場合

HTTP API を使うためには、以下のパッケージをインストールしてください。

BoltzEngine
Boltz Tools (Windows の場合は BoltzEngine HTTP API Proxy)

目次