API Documentation

Introduction

SoCaptcha provides a powerful API that helps you automate captcha verification processes. Our service supports multiple captcha types including sliding puzzles with both straight-line and curved trajectories, specifically optimized for popular e-commerce platforms like Shopee and Temu.

Quick Start

To get started with the SoCaptcha API, you need to:

1. Register an account and obtain your API license key
2. Install our Chrome extension or integrate directly with the REST API
3. Purchase credits and start sending captcha verification requests

const baseUrl = "https://www.socaptcha.com";

// Check remaining credits
const creditsUrl = `${baseUrl}/api/license/credits/v1?licenseKey={licenseKey}`;
const response = await fetch(creditsUrl.replace('{licenseKey}', 'your-license-key'), {
        method: "GET",
        headers: {
            "Content-Type": "application/json"
        }
    }
);
const data = await response.json();
console.log(`Remaining credits: ${data.credits}`);

// Solve a line captcha
const lineUrl = `${baseUrl}/api/shopee/line/v1?licenseKey={licenseKey}`;
const lineResponse = await fetch(lineUrl.replace('{licenseKey}', 'your-license-key'), {
        method: "POST",
        headers: {
            "Content-Type": "application/json"
        },
        body: JSON.stringify({
            puzzle_image_b64: "base64-encoded-puzzle-image",
            piece_image_b64: "base64-encoded-piece-image"
        })
    }
);
const lineResult = await lineResponse.json();
console.log(`Slide proportion: ${lineResult.slideXProportion}`);
                            

Authentication

All API requests require authentication using your license key. You can obtain your license key from your profile page after registration. The license key should be included as a query parameter in your requests:

GET /api/license/credits/v1?licenseKey=your-license-key-here HTTP/1.1
Host: www.socaptcha.com
Content-Type: application/json
                        

Check Credits

Check your remaining credit balance before making captcha solving requests.

GET /api/license/credits/v1?licenseKey={licenseKey}
                                

{
  "credits": 1250
}
                                

Line Captcha Solving

Solve sliding puzzle captchas with straight-line trajectories. This is the most common type of sliding captcha found on e-commerce websites.

POST /api/{siteType}/line/v1?licenseKey={licenseKey}
                                

{
  "puzzle_image_b64": "base64-encoded-puzzle-image",
  "piece_image_b64": "base64-encoded-piece-image"
}
                                

{
  "slideXProportion": 0.745
}
                                

Curve Captcha Solving

Solve advanced sliding puzzle captchas with curved trajectories and rotation. These captchas require more complex movement patterns and piece rotation tracking.

POST /api/{siteType}/curve/v1?licenseKey={licenseKey}
                                

{
  "puzzle_image_b64": "base64-encoded-puzzle-image",
  "piece_image_b64": "base64-encoded-piece-image",
  "slide_piece_trajectory": [
    {
      "pixels_from_slider_origin": 0,
      "piece_rotation_angle": 0,
      "piece_center": {
        "proportionX": 0.1,
        "proportionY": 0.5
      }
    },
    {
      "pixels_from_slider_origin": 50,
      "piece_rotation_angle": 15,
      "piece_center": {
        "proportionX": 0.3,
        "proportionY": 0.45
      }
    }
  ]
}
                                

{
  "pixelsFromSliderOrigin": 142
}
                                

Error Handling

The SoCaptcha API uses standard HTTP status codes to indicate the success or failure of requests.

{
  "code": 401,
  "error": "Invalid license key"
}
                        

Supported Sites

SoCaptcha currently supports captcha solving for the following e-commerce platforms:

Chrome Extension

Our Chrome extension provides seamless integration with supported websites, automatically detecting and solving captchas as you browse.

Best Practices

Follow these recommendations to ensure optimal performance and reliability when using the SoCaptcha API.