REST API Reference

Osiryn Relayを外部アプリケーションからプログラム制御できるB2B向けAPIです。
エンドポイントの動的生成、イベントの検索、統計情報の取得が可能です。（この機能には PRO プラン以上が必要です）

Authentication (認証)

APIにアクセスするには、ダッシュボードの API Keys メニューで生成した「Bearer トークン」が必要です。
以下のすべてのリクエストヘッダーに含めてください。

Authorization: Bearer osy_live_xxxxxxxxxxxxxxxxxxxxxxxxxx

Endpoints API

GET /api/v1/endpoints

アカウントに紐づくすべてのエンドポイントのリストを取得します。

POST /api/v1/endpoints

新しいWebhookエンドポイントを動的に作成します。

Request Body

{
  "name": "User DB Sync (Prod)",
  "source_type": "generic",
  "target_url": "https://api.example.com/sync",
  "signature_secret": "optional_secret_here"
}

Events API

GET /api/v1/endpoints/:id/events

特定のエンドポイントの送受信ログ（イベント履歴）を取得します。

Query ?limit=50 (デフォルト: 50, 最大: 100)
Query ?status=failed (指定したステータスでフィルタ)

POST /api/v1/events/:event_id/retry

指定したWebhookイベントを手動で直ちに再送信します（手動リトライ）。