権限
各 API Token は一組の権限(scope)を持ち、取得できるデータが決まります。権限は「データの種類」で名前が付いています。同じデータは HTTP でも SSE 配信でも同じ権限で、同じリソースのクォータに計上されます。
完全な一覧はオンラインの JSON を正とします:https://manager.exptech.com.tw/api/v1/info/permissions(説明は公開情報 API)。
| 名前 | 説明 | クォータ計上 | 関連ドキュメント |
|---|---|---|---|
* |
すべての権限 | — | — |
account |
アカウント API | いいえ | — |
trem.rts |
TREM リアルタイム観測点 | はい | trem.rts.v1 |
trem.rtw |
TREM リアルタイム波形 | はい | — |
trem.raw |
TREM 生データ | はい | — |
trem.eew |
TREM EEW。自社の TREM システムが算出。非公式で、特定の利用者にのみ提供(下記参照) | はい | — |
trem.intensity |
TREM 震度 | はい | trem.intensity.v1 |
trem.oeews |
TREM 現地型。非公式で、特定の利用者にのみ提供 | いいえ | — |
trem.control |
外部には公開していません | — | — |
eq.report |
地震情報 | はい | eq.report.v1 |
- 「クォータ計上」がはいの権限は、それぞれ 1 つのリソース(
resource_id)に対応します。利用量と 1 日のクォータはリソース単位で計算します。対照表は/api/v1/info/resourcesを参照してください。 - 「関連ドキュメント」が — の権限は、現在、公開ドキュメントのある API では使われていません。
trem.controlは ExpTech 内部専用です。サードパーティは、この権限を申請する必要はなく、申請すべきでもありません。trem.eewは、自社の TREM システムが TREM-net の観測データから独自に算出する TREM EEW で、公式情報ではありません。気象法により ExpTech が個別に同意した、または契約した特定の利用者にのみ提供し、不特定多数には発表しません。すべて中央気象署の発表が優先されます。
*(すべての権限)
Section titled “*(すべての権限)”* は、あとから追加される権限を含め、すべての権限チェックを通ります。購読の代わりにはなりません。利用量も各リソースのクォータに計上されます。テストのときだけ使い、本番では必要な権限だけを付けてください。
グループは、複数の権限を一度に選ぶ書き方です。グループ自体は権限ではありません。
| グループ | 説明 | 含むもの |
|---|---|---|
trem.* |
TREM のすべて(trem.control を除く) |
trem.rts、trem.rtw、trem.raw、trem.eew、trem.intensity、trem.oeews |
eq.* |
地震のすべて | eq.report |
- グループは token の作成時に、上の表の各権限へ展開されます。token に保存されるのは展開後の結果です。その後グループに新しい権限が加わっても、作成済みの token は自動では取得しません。作り直してください。
- 範囲は「含むもの」の列を正とします。名前のプレフィックスから推測しないでください。
trem.controlはtrem.で始まりますが、trem.*には入りません。 - OAuth2 の
access_tokenレスポンスと、ダッシュボードに表示される権限は、どちらも展開後の名前です。グループ名は出ません。
権限の指定方法
Section titled “権限の指定方法”- ダッシュボードで token を作成する:API Token のページで選びます。
- OAuth2:認可リクエストの
scopeパラメータです。空白で区切ります。例:eq.report trem.rts、trem.*。未知の名前はリクエスト全体を失敗させます(invalid_scope)。黙って無視はしません。詳細は OAuth2 を参照してください。
権限のチェック
Section titled “権限のチェック”| 伝送 | チェック | 通らないとき |
|---|---|---|
| HTTP(token が必要なエンドポイント) | token にそのエンドポイントが要求する権限がある、または * がある |
403。本文なし |
| SSE(権限が必要な topic) | 1. token にその topic の権限がある、または * がある2. アカウントがそのリソースを購読している( * は代わりにならない) |
forbidden: token scope missingforbidden: not subscribed |
| SSE(公開 topic) | 権限と購読はチェックしない | — |
権限を通過したあとも、1 日のクォータをチェックします。利用量とクォータを参照してください。各ステータスコードとメッセージはエラーコードを参照してください。
