Create/Confirm Captcha

API Information

URL

 /captcha

Method

 GET, POST

Version

 1.0

Scope

 oob

Authorization Flow

 Client Credentials

GET

This method create new captcha information.

Input Information

This method doesn’t get any input.


Output Information

Name Format Description

CaptchaImage

 String (Base64) Captcha image

CaptchaId

 String Captcha id

Example

Request:

{

}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed"
    },
    "Data": {
        "CaptchaImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYAB...",
        "CaptchaId": "9509AADD99C84C68818FF436794D7C82"
    }
}


POST

This method make confirmation for captcha.

Input Information

Name Format Description Required/Optional

CaptchaId

 String (25) Captcha id Required

CaptchaText

 String (6) Captcha text Required


Output Information

Name Format Description

StatusCode

 Integer Status code

Result

 Boolean Result
true: Captcha is valid.

Example

Request:

{
    "CaptchaId":"E163264A43AA4A42A3861FED0589B995",
    "CaptchaText": "091697"
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed"
    },
    "Data": {
        "StatusCode": 200,
        "Result": true
    }
}