Skip to main content

​
Server APIについて

Server APIは、API Key認証を使用してサーバーサイドから呼び出すAPIです。 管理操作や自社サーバー経由でのメッセージ投稿など、バックエンドシステムからの操作に使用します。

​
主な用途

ユーザー管理

ユーザーの作成・更新・削除、トークン発行

Bot管理

チャットボットの作成とメッセージ送信

管理操作

チャンネル管理、メッセージ管理などの管理者操作

サーバー経由の操作

自社サーバーを経由したメッセージ投稿やチャンネル操作

​
認証方式

Server APIでは、管理画面で発行したAPI Keyを使用します。 
curl -X POST https://<application_id>.chat.rheel.net/v1/users \
  -H "X-Rheel-API-Key: <API_KEY>" \
  -H "Content-Type: application/json"
API Keyは秘密情報です。クライアントサイドのコードに含めず、必ずサーバーサイドでのみ使用してください。

​
ベースURL

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

​
レスポンス形式

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

​
成功レスポンス

{
  "id": "user_123",
  "name": "山田太郎",
  "created_at": "2025-03-21T10:00:00Z"
}

​
エラーレスポンス

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

​
HTTPステータスコード

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

​
次のステップ

API Overview

Server APIの詳細な概要を確認

ユーザー管理

ユーザー作成・管理APIを確認

Bot管理

Bot機能の概要と使い方

全体ドキュメント

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