REST API - CAPTCHA Challenge

 

 


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/captcha

Http Method

GET

Short Description

Responds with script snippet containing CAPTCHA challenge

Query Parameters

N/A

Example Requests

/captcha

HTTP Status Codes

200 OK

500 Internal Server Error

Response headers will include required fields:

RequiredFields: recaptcha_challenge_field,recaptcha_response_field

Description

Workflow:

  1. Send a request to a protected resource.
  2. Detect the status 401 Authorization required.
  3. Determine the authentication scheme and the necessary parameters.
  4. Display the CAPTCHA a human user can solve.
  5. Re-send the request including the CAPTCHA challenge and solution.

A cookbook is available at Cookbook - WebShop REST API.

At least on CAPTCHA service must be configured as enabled for the application/site. Otherwise the resource will return an error.

Cartridge

app_sf_rest
Application

B2C Web Shop, SMB Web Shop

Applications: B2C Web Shop, SMB Web Shop

Product Version

7.5

Product To Version

 

Status

final

TEXT/HTML

 

Request data format

 text/xml

Request related java object

com.intershop.sellside.rest.common.capi.resource.CaptchaResource

Request data example

N/A

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resource.CaptchaResource

Response data example

<script src="http://www.google.com/recaptcha/api/js/recaptcha_ajax.js"> type="text/javascript">Recaptcha.create('6LfdkcASAAAAAM2riv4EctfxSSqlXKSC-SasCYIO', 'captcha');</script>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets