Classic/VPC環境で利用できます。
韓/英キーの設定が間違っていた場合でも、入力した検索キーワードを自動的に変換し、正しい検索キーワードを提案します。
参考
誤字の変換には検索 APIが使用され、検索 APIの1日あたりの呼び出し上限は25,000回です。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /search/v1/errata |
リクエストヘッダ
NAVER API HUBで共通して使用されるヘッダの詳細は、NAVER API HUBのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
query |
String | Required | 検索キーワード
|
format |
String | Optional | レスポンス結果
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET https://naverapihub.apigw.ntruss.com/search/v1/errata?query=spdlqj&format=json
--header X-NCP-APIGW-API-KEY-ID: {Client ID}
--header X-NCP-APIGW-API-KEY: {Client Secret}
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
errata |
String | - | 誤字を変換した結果
|
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 400 | SE01 |
Incorrect query request (無効なクエリリクエストです) | APIリクエスト URLのプロトコルやパラメータなどにエラーがないか確認 |
| 400 | SE02 |
Invalid display value (無効な displayの値です) | displayの値が有効な範囲内であるか確認 |
| 400 | SE03 |
Invalid start value (無効な startの値です) | startの値が有効な範囲内であるか確認 |
| 400 | SE04 |
Invalid sort value (無効な sortの値です) | sortの値に誤字がないか確認 |
| 400 | SE06 |
Malformed encoding (無効な形式のエンコードです) | 検索キーワードを UTF-8でエンコード |
| 404 | SE05 |
Invalid search api (存在しない検索 apiです) | APIリクエスト URLに誤字がないか確認 |
| 500 | SE99 |
System Error (システムエラー) | サーバ内部でエラー発生 |
参考
NAVER API HUBで共通して使用されるレスポンスステータスコードの詳細は、NAVER API HUBのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"errata": "NAVER"
}