Skip to main content

​
Client APIについて

Client APIは、セッショントークン認証を使用してクライアントアプリから呼び出すAPIです。 エンドユーザーがチャットアプリを利用する際の、メッセージ送信やチャンネル操作などに使用します。

​
主な用途

メッセージ操作

メッセージの送信・編集・削除、既読管理

チャンネル操作

チャンネルの作成・参加・退出、メンバー管理

リアクション

メッセージへのリアクション追加・削除

ユーザー情報

ユーザー一覧の取得、プロフィール確認

​
認証方式

Client APIでは、セッショントークン発行APIで取得したセッショントークンを使用します。 
curl -X POST https://<application_id>.chat.rheel.net/v1/channels \
  -H "Authorization: Bearer <SESSION_TOKEN>" \
  -H "Content-Type: application/json"
セッショントークンは、Server APIの「セッショントークン発行」エンドポイントで取得します。

​
セッショントークンの取得

  1. Server APIでユーザーを作成
curl -X POST https://<application_id>.chat.rheel.net/v1/users \
  -H "X-Rheel-API-Key: <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "user123",
    "name": "山田太郎"
  }'
  1. セッショントークンを発行
curl -X POST https://<application_id>.chat.rheel.net/v1/users/user123/token \
  -H "X-Rheel-API-Key: <API_KEY>"
レスポンス: 
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expired_at": "2025-03-21T10:00:00Z"
}
  1. Client APIで使用
取得したtokenをAuthorizationヘッダーで使用します。

​
ベースURL

https://<application_id>.chat.rheel.net/v1
<application_id>は管理画面で作成したアプリケーションのIDに置き換えてください。

​
レスポンス形式

すべてのレスポンスはJSON形式で返されます。

​
成功レスポンス

{
  "id": "ch_123",
  "name": "一般チャット",
  "created_at": "2025-03-21T10:00:00Z"
}

​
エラーレスポンス

{
  "error": {
    "code": "ERROR_CODE",
    "message": "エラーの詳細メッセージ"
  }
}

​
HTTPステータスコード

コード説明
200成功
400リクエストが不正です
401認証に失敗しました（トークンが無効または期限切れ）
403アクセス権がありません
404リソースが存在しません
500サーバーエラー

​
次のステップ

チャンネル操作

チャンネルの作成と管理

メッセージ送信

メッセージの投稿と管理

WebSocket接続

リアルタイム通信の実装

全体ドキュメント

Rheel Chat APIドキュメントトップへ