トピックの作成

ここでは、スコープごとにトピックの作成方法を説明していきます。

アプリケーションスコープのトピックの作成

アプリケーションスコープのトピックは、アプリ開発者のみ作成できます。作成したトピックは、全てのアプリユーザーから購読できますが、このトピックにメッセージを送信できるのは、デフォルト状態ではトピック作成者（つまりアプリ開発者）だけです。

アプリケーションスコープのトピックは、次の手順で作成します。

  1. アプリ管理者向け機能 の内容に従い、アプリ管理者トークンを取得します。
  2. 次の例のようにしてアプリケーションスコープのトピックを作成します（この例では "SendingAlert" という名前のトピックを作成しています）。
curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/topics/SendingAlert" \
  -d ""

{APP_ID} には実際の AppID の値を入れます。また、取得したアプリ管理者トークンを {ACCESS_TOKEN} の箇所に入れてください。

トピック名は英数字、"-"、"_" から構成される 64 文字までの文字列として指定します。

Kii Cloud は以下の応答を返します。

  • トピックの作成に成功した場合、204 応答を返します。
  • 同じ名前のトピックがすでに存在する場合は、エラーコード TOPIC_ALREADY_EXISTS を 409 応答で返します。

グループスコープのトピックの作成

グループスコープのトピックは、グループメンバーであれば誰でも作成可能です。また、デフォルト状態ではグループメンバーであれば誰でも購読可能であり、全てのグループメンバーがトピックに対してメッセージを送信できます。

グループスコープのトピックは通常アプリケーションによって動的に作成します。

以下に "GroupTopic" という名前のトピックをグループスコープに作成する例を挙げます。

curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/groups/{GROUP_ID}/topics/GroupTopic" \
  -d ""

{APP_ID} は実際のアプリの値に、{GROUP_ID} は対象グループの ID にそれぞれ置き換えてください。

トピック名は英数字、"-"、"_" から構成される 64 文字までの文字列として指定します。

Kii Cloud は以下の応答を返します。

  • トピックの作成に成功した場合、204 応答を返します。
  • 同じ名前のトピックがすでに存在する場合は、エラーコード TOPIC_ALREADY_EXISTS を 409 応答で返します。

ユーザースコープのトピックの作成

ユーザースコープのトピックは、ログイン済みのユーザーであれば誰でも作成可能です。このトピックはデフォルト状態ではユーザーに閉じており、トピックの購読およびトピックへのメッセージ送信を行えるのはこのユーザーのみになります。

ユーザースコープのトピックは通常アプリケーションによって動的に作成します。

以下に "MyTODO" という名前のトピックをユーザースコープに作成する例を挙げます。

curl -v -X PUT \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/{USER_ID}/topics/MyTODO" \
  -d ""

{APP_ID} は実際のアプリの値に、{USER_ID} は対象ユーザーの ID にそれぞれ置き換えてください。

トピック名は英数字、"-"、"_" から構成される 64 文字までの文字列として指定します。

Kii Cloud は以下の応答を返します。

  • トピックの作成に成功した場合、204 応答を返します。
  • 同じ名前のトピックがすでに存在する場合は、エラーコード TOPIC_ALREADY_EXISTS を 409 応答で返します。