# UptimeScoutでサービス可用性APIを連携する方法



URL: https://uptimescout.com/ja/blog/availability-api-integration/



すべてのレスポンスを色付きの点に置き換えるのではなく、タイムスタンプと不確実性を明示する可用性パネルを構築しましょう。



## ポーリングの前にサービスIDを確認する



まずservicesエンドポイントを使い、UptimeScoutで使用される識別子を確認してください。人間が読むブランド名とAPIの識別子は、必ずしも同じではありません。ステータスと履歴のリクエストが同じ対象を参照するよう、IDと地域をアプリケーション設定に保存してください。

Evelodeで対象となるライセンスを取得し、サーバー側のシークレットまたは環境変数に保管してください。有料のキーをブラウザーのJavaScript、公開リポジトリ、スクリーンショット、URLに埋め込まないでください。



## 認証付きステータスリクエストを送信する



例を実行する前に、ご自身の環境でEVELODE_LICENSE_KEYを設定してください。この例はUSにおけるGitHubの観測結果をリクエストするものです。リクエストのテンプレートであり、GitHubの現在のステータスを示すものではありません。



```sh

curl -G https://api.uptimescout.com/v1/status \
  --data-urlencode "service=github" \
  --data-urlencode "region=US" \
  -H "Authorization: Bearer $EVELODE_LICENSE_KEY"

```



## 表示する前にレスポンスを解釈する



リクエストが正常に通信できたことと、サービスの可用性シグナルは別の層の情報です。まずHTTPステータスとレスポンスの外側の構造を検証してください。次にservice.status、service.observed_at、service.staleを確認します。unknownやstaleを明示し、暗黙にoperationalとして扱わないでください。

観測時刻とあわせて地域も保存してください。独自のインターフェースを毎分更新する場合は、アプリケーションがレスポンスを取得した時刻と、観測時刻を分けて表示しましょう。HTTPレスポンスが新しくても、その中の観測データは古いことがあります。



## リクエスト量を計画し、上限に対処する



ワークフローに合う場合は一括ステータスを使い、選択したプランで一括リクエストの最大件数を確認してください。リクエスト枠と1分あたりのリクエスト上限は別の制限です。REST、SDK、MCPのアクセスは、同じライセンスのリクエスト計上を共有します。

HTTP 429が返された場合はRetry-Afterに従い、直後に集中して再試行しないでください。一時的なエラーには、待ち時間を段階的に増やしながら上限を設けて再試行します。認証エラーや無効なパラメーターのエラーを際限なく再試行しないでください。更新やプラン変更によりライセンスの利用枠が更新されます。暦月の初日にリセットされることはありません。



## 公開前に不確実なケースをテストする



既知のサービス、未知のID、キーなし、無効なパラメーター、古い観測、観測データの欠落をテストしてください。各ケースでインターフェースに分かりやすいメッセージが表示されることを確認します。認証情報やアカウント情報を含む場合は、診断結果全体を公開ログに記録しないでください。

APIドキュメントには、公開されている7つのメソッドすべてとOpenAPIスキーマが掲載されています。jsonscraperから、Python、Node.js、PHP、Go、Java、.NETのSDKにアクセスできます。クライアントライブラリを使えば通信処理を簡素化できますが、不確実性の解釈方法はアプリケーション側で決める必要があります。



## リソース

https://uptimescout.com/ja/docs/

https://uptimescout.com/ja/methodology/

https://uptimescout.com/ja/contacts/
