Notification > Notification Hub > API v1.0使用ガイド > 共通情報
!!! danger 「注意事項」 * Notification Hub v1.0 APIは現在アルファ(alpha)状態であり、安定しておらず、実験的な機能が追加または削除される可能性があります。 * APIはサービス改善のためにいつでも変更される可能性があり、変更された場合、事前告知なしに変更されることがあります。 * Notification HubがGA(General Availability)状態に移行後、公式バージョンに変更されます。 * 変更可能な部分は、この文書で説明するAPIエンドポイント、認証、リクエスト制限、リクエスト、レスポンス、フィールドなどの全ての項目が含まれます。
| リージョン | エンドポイント |
|---|---|
| Global | https://notification-hub.api.nhncloudservice.com |
X-NHN-Authorization: Bearer {accessToken}
POST https://oauth.api.nhncloudservice.com/oauth2/token/create
Content-Type: application/x-www-form-urlencoded
Authorization: Basic {{oauthAuthorization}}
curl -X POST "https://oauth.api.gov-nhncloudservice.com/oauth2/token/create" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Authorization: Basic {{oauthAuthorization}}"
リスト照会では個人情報以外の照会条件に対して、プレフィックス及び単一文字ワイルドカード検索がサポートされます。
広告_で始まるテンプレートを検索します。
GET /message/v1.0/templates?templateName=広告 -1で終わるテンプレートを検索します。
GET /message/v1.0/templates?templateName=__-1
成功レスポンスのHTTPステータスコードは200 OKです。
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
}
}
失敗レスポンスのHTTPステータスコードは4xxと 5xxです。
{
"header": {
"isSuccessful": false,
"resultCode": 400629,
"resultMessage": "失敗に関する情報が含まれています。"
}
}
| 名前 | タイプ | 説明 |
|---|---|---|
| header.isSuccessful | Boolean | API呼び出し成否です。 |
| header.resultCode | Integer | 結果コードです。成功は0、失敗は400000以上の値を持ちます。 |
| header.resultMessage | String | 結果メッセージです。失敗に関する情報が含まれています。 |
!!! danger 「注意事項」 * リクエスト数の計算は、クライアント、サーバー間の時間差、ネットワーク遅延によって異なる測定を行い、計算された値が異なる場合があります。 * 300RPSを超えると、サーバーはHTTPステータスコード429(Too Many Requests)レスポンスでクライアントのリクエストを拒否します。 * リクエストが拒否された場合、クライアントが即時再試行すると、サーバーのリクエスト拒否が長い時間維持されることがあります。 * クライアントは、リクエストが拒否されたら、指数バックオフ(Exponential Backoff)のように再試行間隔を増やして呼び出すことを推奨します。
Notification Hub API使用ガイドでは、IntelliJ HTTP、cURLでのAPI呼び出し例を提供します。
IntelliJ HTTP環境変数設定ファイル例(htt-client.env.json)
{
"default": {
"endpoint": "https://notification-hub.api.nhncloudservice.com",
"appKey": "アプリキー",
"accessToken": "認証トークン"
}
}
cURL環境変数設定例
ENDPOINT=https://notification-hub.api.nhncloudservice.com
APP_KEY=アプリキー
ACCESS_TOKEN=認証トークン