おしらせアプリのAPIは、OAuth2による認可と通知用のAPIで構成されています。
認可系APIのエンドポイントのホスト名はoshirase.appです。
OAuth2におけるauthorization endpoint URIです。
メソッド/ヘッダ
| 項目 | 値 |
|---|---|
| Method | GET |
パラメータ
| パラメータ名 | 必須 | 型 | 説明 |
|---|---|---|---|
| response_type | 必須 | 固定値 | "code"を指定 |
| client_id | 必須 | string | 発行されたOAuthクライアントID |
| redirect_uri | 必須 | uri | 登録済みのリダイレクトURI |
| scope | 必須 | 固定値 | "notify"を指定 |
| state | 必須 | string | CSRF対策用のトークン |
| response_mode | 任意 | string | "form_post"を指定するとPOSTでリダイレクト |
成功時
| パラメータ名 | 型 | 説明 |
|---|---|---|
| code | string | アクセストークン取得用コード |
| state | string | リクエスト時のstateパラメータ |
エラー時
| パラメータ名 | 型 | 説明 |
|---|---|---|
| error | string | エラーコード |
| error_description | string | エラーの詳細説明 |
| state | string | リクエスト時のstateパラメータ |
OAuth2のtoken endpointです。
メソッド/ヘッダ
| 項目 | 値 |
|---|---|
| Method | POST |
| Content-Type | application/x-www-form-urlencoded |
パラメータ
| パラメータ名 | 必須 | 型 | 説明 |
|---|---|---|---|
| grant_type | 必須 | 固定値 | "authorization_code"を指定 |
| code | 必須 | string | 認可コード |
| redirect_uri | 必須 | uri | 認可時に指定したリダイレクトURI |
| client_id | 必須 | string | クライアントID |
| client_secret | 必須 | string | クライアントシークレット |
ヘッダ
| 項目 | 値 |
|---|---|
| Status | 200: 成功 400: リクエスト不正 401: 認可エラー |
| Content-Type | application/json |
本文
| 名前 | 型 | 説明 |
|---|---|---|
| access_token | string | 通知API用のアクセストークン |
通知系APIのエンドポイントのホスト名はoshirase.appです。
全てのAPIで認可ヘッダAuthorization: Bearer <access_token>が必要です。
通知を送信します。
メソッド/ヘッダ
| 項目 | 値 |
|---|---|
| Method | POST |
| Content-Type | application/x-www-form-urlencoded |
| Authorization | Bearer |
パラメータ
| パラメータ名 | 必須 | 型 | 説明 |
|---|---|---|---|
| message | 必須 | string | 通知メッセージ (最大1000文字) |
| imageThumbnail | 任意 | URL | サムネイル画像のURL (JPEG, 最大240×240px) |
| imageFullsize | 任意 | URL | フル画像のURL (JPEG, 最大2048×2048px) |
| notificationDisabled | 任意 | boolean | 通知を無効化するか (デフォルト: false) |
ヘッダ
| 項目 | 値 |
|---|---|
| Status | 200: 成功 400: リクエスト不正 401: 認可エラー 429: レート制限超過 |
| Content-Type | application/json |
本文
| 名前 | 型 | 説明 |
|---|---|---|
| status | number | HTTPステータスコード |
| message | string | 結果メッセージ |
通知の連携状態を確認します。
メソッド/ヘッダ
| 項目 | 値 |
|---|---|
| Method | GET |
| Authorization | Bearer |
ヘッダ
| 項目 | 値 |
|---|---|
| Status | 200: 成功 401: 認可エラー |
| Content-Type | application/json |
本文
| 名前 | 型 | 説明 |
|---|---|---|
| status | number | HTTPステータスコード |
| message | string | 結果メッセージ |
| targetType | string | "USER"または"GROUP" |
| target | string | ユーザー名またはグループ名 |
通知の連携を解除します。
メソッド/ヘッダ
| 項目 | 値 |
|---|---|
| Method | POST |
| Content-Type | application/x-www-form-urlencoded |
| Authorization | Bearer |
ヘッダ
| 項目 | 値 |
|---|---|
| Status | 200: 成功 401: 認可エラー |
| Content-Type | application/json |
本文
| 名前 | 型 | 説明 |
|---|---|---|
| status | number | HTTPステータスコード |
| message | string | 結果メッセージ |