入力値の照合

Prev Next

Classic/VPC環境で利用できます。

ユーザーが入力した CAPTCHA画像の値(文字列または数字)と実際の CAPTCHA値(文字列または数字)を照合します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /nkey

リクエストヘッダ

CAPTCHA APIで共通して使用されるヘッダの詳細は、CAPTCHAの共通ヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer Optional CAPTCHAキーを照合するための入力値
  • 0 | 1(デフォルト)
key String Required CAPTCHAキー発行 APIを呼び出して取得したキー
value String Required CAPTCHA画像に対するユーザーの入力値

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/captcha/v1/nkey?code=1&key={key}&value={value}' \
--header 'X-NCP-APIGW-API-KEY-ID: {アプリの登録時に発行された Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {アプリの登録時に発行された Client Secret}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result Boolean - ユーザーの CAPTCHA入力値は正解かどうか
  • true | false
    • true: 正解
    • false: 誤答
responseTime Double - 正解するまでかかった時間(秒)
  • -1~7200
  • 小数点第二位まで表示
    • <例> 123.12

レスポンスステータスコード

CAPTCHA APIで共通して使用されるレスポンスステータスコードの詳細は、CAPTCHAの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": true,
    "responseTime": 22.9
}