CAPTCHAの導入方法

1. CAPTCHAの表示・認証フロー

guide_outline_ja

  1. サイト訪問者がCAPTCHAを含んだページをリクエストします。
  2. リクエストされたページを返します。このページにはCAPTCHA表示用のJavaScriptが含まれます。
  3. ページが表示されると、サイト訪問者のブラウザがCapyサーバーに対してCAPTCHAの表示をリクエストします。
  4. リクエストされたCAPTCHAに使用する画像をサイト訪問者に返します。
  5. CAPTCHAの回答等を含んだフォーム情報をあなたのウェブサイトに対してPOSTします。
  6. あなたのウェブサイトは、サイト訪問者の回答が正しいかどうか、Capyサーバーに照会します。
  7. Capyサーバーは渡されたデータを元に、CAPTCHA処理の結果をあなたのウェブサイトに返します。
  8. あなたのウェブサイトは得られたCAPTCHA処理の結果に応じて処理を行います。

ユーザー登録は現在、招待制になっております。必要な情報を入力した後、招待されるまでお待ちください。
ユーザー登録はこちら

2. ユーザー登録とログイン

ユーザー登録は現在、招待制になっております。必要な情報を入力した後、招待されるまでお待ちください。
ユーザー登録はこちら

ユーザ登録がお済みの場合はログインしてください。
ログインはこちら

login

3. CAPTCHAのJavaScriptのコードを取得

ログインすると、ダッシュボードのトップページが表示されますので、
使用したいサービスを、左側の「サービス」メニューより選択ください。

「パズルCAPTCHA」もしくは「アバターCAPTCHA」を選択すると、
下図のように、現在利用可能なCAPTCHAのリストが表示されます。

利用したいCAPTCHAのJavaScriptコードをコピーしてください。

リストにCAPTCHAがない場合は、追加ボタンをクリックしてCAPTCHAを作成してください。

add_puzzleadd_avaar

4. CAPTCHAの設置

あなたのウェブサイト上でCAPTCHAを表示したい箇所に、コピーしたコードを貼り付けてください。
コードはプログラムによる自動POSTを防ぎたいformタグの中に貼り付けます。

このコードはブラウザで表示されるとCAPTCHAに変換されます。

5. サイト訪問者によるCAPTCHAの回答結果の取得

CAPTCHAに変換されたコードを含んだフォームがPOSTされると、あなたのウェブサイトのサーバーに、CAPTCHA用の情報を含んだPOSTデータが送信されます。

このPOSTデータの中から’capy_challengekey’と’capy_answer’の2つのデータを取得してください。

6. あなたのAPIキーの確認

サイト訪問者のCAPTCHAの回答を照会するためには、あなたのAPIキーが必要です。
APIキーは各Capyユーザーに一意に割り当てられたランダムな英数字で、アカウント情報のページで確認できます。
アカウント情報の確認はこちら

7. CAPTCHAの回答の照会

POSTデータを受け取ったら、CAPTCHAの回答結果を照会します。
表にある4つのデータを下記のリクエストURLにPOSTしてください。

パズルCAPTCHA用URL

https://jp.api.capy.me/puzzle/verify

アバターCAPTCHA用URL

https://jp.api.capy.me/avatar/verify
キー キーの説明
capy_challengekey 各CAPTCHAの問題毎に割り当てられるキーです。
これを元に、どのCAPTCHAが利用されたのか判断します。
CHALLENGE_sampleLHEwkZTvxwN6yar7evhSmAFM
capy_privatekey 各Capyユーザー毎に割り当てられるAPIキーです。
これを元に、どのCapyユーザーが照会しているのか判断します。
KEY_sampleYdpqbb9CWvMk3665FYmmoisW
capy_answer サイト訪問者による、CAPTCHAの回答を表す文字列です。
正しい回答であれば、Capyサーバーはtrueを返します。
10,20,30,40,

8. CAPTCHA照会後のアクション

CapyサーバーからCAPTCHAの照会結果として、下記の文字列が照会元サーバーに返されます。
この文字列は1行目にtrueまたはfalseでCAPTCHAの照会結果を示し、2行目でエラーコードを示します。
この結果を元に、アカウント作成、ブロック等の処理を行なってください。

結果 結果の説明
成功 true
success
サイト訪問者の回答は正解です。
失敗 false
incorrect-answer
サイト訪問者の回答は間違っています。
false
invalid-request-method
Capyサーバーに対してPOSTで送信されていません。
false
invalid-post-parameters
POSTのパラメータが間違っています。
照会にはcapy_challengekey, capy_privatekey, capy_answer, capy_ip_addressの4つの情報が必要です。
false
invalid-private-key
あなたのAPIキーが間違っています。
false
invalid-challenge-key
POSTデータのcapy_challengekeyの値が間違っています。
false
is-not-active
同一時間、同一IPアドレスによりリクエストされた、既に回答済みのCAPTCHAです。
false
invalid-capcha-key
POSTデータのcapy_captchakeyの値が間違っています。
false
invalid-onetime-captcha
1回だけ認証使用時に、ログイン時に使用するユーザーIDが前回のものと異なるか、クッキーのデータが間違っています。
false
unknown-error
未知のエラーです。