はじめに
5分以内にPulseAPIを使い始めましょう。
1
サインアップ
でアカウントを作成してください。/signup.
2
最初のエンドポイントを追加
サインイン後、オンボーディングウィザードが表示されます。最初のエンドポイントを追加してください:
- API URLを入力してください(例:https://api.example.com/health)
- HTTPメソッドを選択(GET、POSTなど)
- チェック間隔を設定(1〜60分)
- タイムアウトを設定(5〜60秒)
{
"url": "https://api.example.com/health",
"method": "GET",
"checkInterval": 60,
"timeout": 10
}3
ステータスページを設定
ユーザーと稼働率を共有するための公開ステータスページを作成します。ダッシュボード > ステータスページに移動。
- URL用のユニークなスラッグを選択
- ロゴ、カラー、会社名でカスタマイズ
- 表示するエンドポイントを選択
- オプションでカスタムドメインを追加(例: status.yourcompany.com)
4
アラートを設定
PulseAPIは以下の場合に自動的にアラートを送信します:
ダウンタイム2回連続の失敗でアラートが発動
回復ダウンタイム後にエンドポイントがオンラインに復帰
低速応答時間が2000msを超過(最大1アラート/時間)
すべてのアラートはサインアップメールに送信されます。追加チャネルについては設定でWebhookとTelegramを設定してください。
5
モニターダッシュボード
エンドポイントが追加されると、PulseAPIはすぐに監視を開始します。以下を確認できます:
- リアルタイムステータス(稼働中、ダウン、低下)
- 応答時間チャート(過去7日間)
- 稼働率(24時間ローリングウィンドウ)
- チェック履歴テーブル(ページネーション、ソート可能)
6
APIを使用する
PulseAPIへのプログラムアクセス用のAPIキーを作成します。
- ダッシュボード > 設定 > APIキーに移動
- 作成をクリックし、名前を付けてスコープを選択(例: endpoints:read, alerts:read)
- キーをすぐにコピーしてください -- 一度しか表示されません
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints
# Trigger a manual check
curl -X POST -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints/ENDPOINT_ID/check完全なエンドポイントリストについてはを参照してください。APIリファレンス
ヘルプが必要ですか?
ご質問やフィードバックがありますか? までメールしてください - すべてのメッセージに返信します。[email protected]