Available in Classic and VPC
CAPTCHA is a NAVER Cloud Platform service that prevents automatic input by distinguishing between humans and computers. The CAPTCHA service provides APIs in RESTful form for CAPTCHA (Image), which sends an image containing characters identifiable to the human eye and verifies the input value, and CAPTCHA (Audio), which sends an audio message containing numbers and verifies the input value.
Common CAPTCHA settings
The following describes commonly used request and response formats in CAPTCHA APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
Issue CAPTCHA (Image) key, compare input values: https://naveropenapi.apigw.ntruss.com/captcha/v1
Request CAPTCHA (Image) image file: https://naveropenapi.apigw.ntruss.com/captcha-bin/v1
Issue CAPTCHA (Audio) key, compare input values: https://naveropenapi.apigw.ntruss.com/scaptcha/v1
Request CAPTCHA (Audio) audio file: https://naveropenapi.apigw.ntruss.com/scaptcha-bin/v1
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-api-key-id |
Required | Client ID issued after application registration in NAVER Cloud Platform console |
x-ncp-apigw-api-key |
Required | Client secret issued after application registration in NAVER Cloud Platform console |
For information on how to register an application in the NAVER Cloud Platform console to obtain authentication information (client ID, client secret) required to use the API, see CAPTCHA User Guide.
In the console, make sure that the API you want to use after registering the application is selected by clicking the [Edit] button. If it is not selected, you will receive a 429 (Quota Exceed) error.
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 400 | CT002 | Unissued image or wav | Image or audio file not issued |
| 403 | CT001 | Invalid Key | Expired or missing key |
| 500 | CT500 | System Error | Internal server error |
CAPTCHA API
The following describes the APIs provided by the CAPTCHA service.
| API | Description |
|---|---|
| CAPTCHA (Image) > Issue key | Issue CAPTCHA image key |
| CAPTCHA (Image) > Request image file | Request CAPTCHA image file |
| CATPCHA (Image) > Compare input value | Compare CAPTCHA image value to user input |
| CAPTCHA (Audio) > Issue key | Issue CAPTCHA audio key |
| CAPTCHA (Audio) > Request image file | Request CAPTCHA audio file |
| CATPCHA (Audio) > Compare input value | Compare CAPTCHA audio value to user input |
CAPTCHA related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand CAPTCHA APIs.
- CAPTCHA API guides
- API overview: how to issue and check access key and secret key issued by NAVER Cloud Platform, how to generate the signature required for request headers
- API Gateway User Guide: how to check the API key required for the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the CAPTCHA service
- How to use the CAPTCHA service
- CAPTCHA User Guide: how to use CAPTCHA in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of CAPTCHA
- Latest service news: latest news on CAPTCHA
- FAQ: frequently asked questions from CAPTCHA users
- Contact Us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.