Resellers API Reference
Introduction
The Reseller API is a RestFul Web Service API that serves users for white-labelling CAPTCHAs.IO offered services. The API offers methods that provides a way for our services to be catered to resellers wanting to offer CAPTCHA solving service to end-users at their own logo.
Requirements
- CAPTCHAs.IO Reseller Account - Register and create an account at https://app.captchas.io/reseller/onboard/ .
- Paddle.com - Paddle.com is free to join and a very convenient payment solution.
Features
- Pay as you go payment scheme.
- Unlimited daily solving.
- Supports image, reCAPTCHA, and audio captchas.
-
Base price rate:
- reCAPTCHA: $1 per 1000 solves
- Image: $0.5 per 1000 solves
- Audio: $0.7 per 1000 solves
Scheme
- HTTP
RecognitionImage, Audio, & reCAPTCHA
POSTGET https://api.captchas.io/reseller/image
Recognizing Image CAPTCHAs
Parameters
| Name | Description |
|---|---|
file *
(the captcha file) |
The CAPTCHA file uploaded to the server for recognition. @/path/to/the/image/captcha.png |
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
| Code | Description |
| 200 | successful operation OK|0.0142|f84D4Q88 |
POSTGEThttps://api.captchas.io/reseller/recaptcha_task
Recognizing reCAPTCHAs v2, v3 and invisible
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
googlekey *
(google sitekey) |
The Google reCAPTCHA data-sitekey value. 6LdEiHEUAAAAAAyyS8r6mz1WvWmHBm1_dU-cRTu_ |
pageurl *
(page URL) |
The page URL of the website containing the reCAPTCHA. https://www.emeraldchat.com/ |
version *
(reCAPTCHA Version) |
The reCAPTCHA version. Possible values v2, v3 & invisible. v2 |
min_score *
(minimum score) |
The reCAPTCHA minimum score. 0.5 - Default: 0.1 ... 0.3 ... 0.5 ... 0.9 0.5 |
| Code | Description |
| 200 | successful operation OK|4.7185|b351e6b6 b351e6b6 is the captcha_id which should used for recaptcha_result requests. See below...
|
POSTGEThttps://api.captchas.io/reseller/recaptcha_result
View reCAPTCHA task result.
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
captcha_id *
(task captcha ID) |
The CAPTCHA ID taken from recaptcha_task response as seen above. b351e6b6 |
| Code | Description |
| 200 | successful operation OK|13.4451|03AOLTBLTZISIAe1of3o_2b2COkiAe-G5dEXvmtzXBuuSQYR926bGk-pSCOBr67VsdRYfy-S7Gz3CDZ8hl1jwAq-UssoSnLFJ9EXrMMAC5XRBkxlhi5X_wJ8Qzafq1ZRUDl7JT4cwtzy1exkPhWMnpJE7lI2JJnhx_pz_8MpDdbIGLTcvQsrqNvcIHEirbQJ951f18J-lRxJ0oViuiJtMyOZJQm4uf3IMv_kdynRTi18mht3qeC47enq24FAixuXtMB-Gw-p7pA1UawpsJe2n7z9qd_foViX88sBvabSNPeGXfjdpPYOArTChgJUj7yJ_jKCp-yYzsk1sEVxtE39cikAmOYIxxYmtO8XXYJrvL2J6KqlVjePXXZE3JVgPqXMX00Cm5L0qFtQkUXrgFuPddem8Jr3W9lrW6KA |
POSTGEThttps://api.captchas.io/reseller/audio
Recognizing Audio CAPTCHAs
Parameters
| Name | Description |
|---|---|
file *
(audio captcha file) |
The audio CAPTCHA file uploaded to the server for recognition. @/path/to/the/audio/captcha.wav |
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
| Code | Description |
| 200 | successful operation OK|0.4152|10984756734 |
POSTGEThttps://api.captchas.io/reseller/history
User's recognition history
Parameters
| Name | Description |
|---|---|
user_key *
(user key) |
User API key found in user's dashboard. 9j6210k6f7sf35.781w0017 |
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
| Code | Description |
| 200 | successful operation
[
{
"total": 2,
"recaptcha": 2,
"image": 0,
"audio": 0
},
"solves": [{
"id": "c1f9b533",
"elapsed": "75.3692",
"captcha_type": "recaptcha",
"base64": "",
"answer": "03AOLTBLQNBly-tl_33kVhO3Ii7el8Bpx_m4J0B3ackHl7fnu3O4s5DDaywLnhQdxbIIlnlvrWzli-qORdV6uBVqo7OSKNPV4oxWqnSUUQjmRYZZDwHYZ-V_TkDD_t3uORtCHuDpwYeEZBzqxQgLFp-VAZHV2-gBl0p9heqoMTFFzEEF36YNtGNpyINGL7gXlpx4-oFEJhSexrv6VvAOOFYaM-nGPnEezSsqCuu3K7cULTOEevnuysjYc50gtevW3KRjiY2rtBojgItOFfHZCz-t8Uz9VsMrXdUWZjVYKWLeW6SfHx0ZOHn6WI1bqd6Ai6kRl7tPMSKNm4sye5vt1YgQ8m49cHQsPdAqK_uxWVOkA7E1ALFKQ9OjJ1_8sbIsorqsy6FyrycE9ESQVHaDrqBh17IjqUO2ZhlQ"
},
{
"id": "6f92b676",
"elapsed": "23.0001",
"captcha_type": "recaptcha",
"base64": "",
"answer": "03AOLTBLQinRwnz2YCIXzk9tak1cKO7QYFQaSOjprRXnS8EQV54TLuzIXPQQidxZza0ykCc2d6dWCUbpfXmpHLTaNcK4Wx-jjs-AY86HLAWSMpSzBfhbxrPF_MqPScZzvHW_IKtm0mbF0eNqkzWZ-TePx73FXHukSPaWkS23Sv8fxTj83BdfmPGJLmNAjL4f1_8PawkS29oSYYZQ6ildzMHXkSqtVL5gUmJ2yjeKrX7nyWNLrGPU6-BL8f2kP0AkSU9eQJ0qiwq19CppHvIyG11dWJZ3UbgEJWcEauIBEdaDnF98kfy7OlMUz_SAuNbtgJTcbNDK_Sn-MHvRqatRbcMRH2L5Eb-_DlUKb5YH5_LO_LZkA-kUaWXesyL4rrgMNuZRoAL45KIqFslZlQdxOACOhlcot_VFMJRQ"
}]
]
|
PaymentsCreate and Pay Orders
POSTGEThttps://api.captchas.io/reseller/user_orders
Generate user order list.
This payment API uses Paddle.com as payment processor. You may use your own payment processors.
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
user_key *
(user key)
|
The user or customer website key found in user's dashboard. 9j6210k6f7sf35.781w0017 |
Responses
| Code | Description |
| 200 | successful operation
[
{
"total": 2
},
"orders": [{
"id": "787F2E6B",
"reseller": "rsc-xxxxxxxxxxxxxx.xxxxxxxx",
"user": "usr-xxxxxxxxxxxxxx.xxxxxxxx",
"product_name": "Example Product",
"price": "100",
"currency":"USD",
"image_url":"https://captchas.io/images/icon-200.png",
"webhook_url":"https://pay.xxxxxxx.xxx/path/to/webhook_app",
"status":"paid",
"payment_method":"paddle",
"payment_url":"https://checkout.paddle.com/checkout/custom/eyJjYyI6eyJVU0QiOiIxMDAifSw..."
},
{
"id": "423A7R8K",
"reseller": "rsc-xxxxxxxxxxxxxx.xxxxxxxx",
"user": "usr-xxxxxxxxxxxxxx.xxxxxxxx",
"product_name": "Example Product",
"price": "40",
"currency":"USD",
"image_url":"https://captchas.io/images/icon-200.png",
"webhook_url":"https://pay.xxxxxxx.xxx/path/to/webhook_app",
"status":"unpaid",
"payment_method":"paypal",
"payment_url":"https://domain.com/path/to/payment"
}]
]
|
POSTGEThttps://api.captchas.io/reseller/create_order
Create customer order and generate pay link.
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
user_key *
(user key)
|
User API key found in user's dashboard. 9j6210k6f7sf35.781w0017 |
product_name *
(name of the product)
|
Custom product name. Company Package #1 |
price *
(the price)
|
Custom product price. 48.50 |
currency *
(the currency)
|
Custom product price currency. USD |
image_url *
(image URL)
|
Product image URL. https://example.com/path/to/product/image.png |
return_url *
(payment return URL)
|
Payment custom return URL. https://example.com/path/to/payment.php |
payment_method *
(the payment method)
|
Payment method of order. We have Paddle.com only at the moment. Soon we can have PayPal and etc... paddle |
Responses
| Code | Description |
| 200 | successful operation
[
{
"payment_link": "https://pay.captchas.io/resellers/orders/J0IUHJVZ",
"order_id": "J0IUHJVZ"
}
]
|
Users Creation, Updating, Listing, & Statistics
POSTGEThttps://api.captchas.io/reseller/get_balance
View reseller available account credit balance.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
Responses
| Code | Description |
| 200 |
successful operation 327.51 |
POSTGEThttps://api.captchas.io/reseller/get_user_balance
View user's available account credit balance.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_key *
(user key)
|
User API key found in user's dashboard. 9j6210k6f7sf35.781w0017 |
Responses
| Code | Description |
| 200 |
successful operation 34.51 |
POSTGEThttps://api.captchas.io/reseller/register_user
Register a new user.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
email *
(email address)
|
User's email address. user@example.com |
|
password *
(user password)
|
User's password in text format. MyPassword123 |
|
name *
(user name)
|
User's complete name in text format. My Name User |
|
ip *
(IP address)
|
User's unique IP address. 11.6.32.1 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"password": "MyPassword123",
"credits": 12.45,
"name": "My Name User",
"key": "5d81h7a48bdbg1.347h4081"
}
]
|
POSTGEThttps://api.captchas.io/reseller/update_user
Update user profile.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_id *
(user ID)
|
User's ID found in database. usr-9j6210k6f7sf35.781w0017 |
|
password *
(user password)
|
User's password in text format. MyPassword123 |
|
name *
(user name)
|
User's complete name in text format. My Name User |
|
credits *
(user credits)
|
User's account credit balance. 563.2 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"id": "usr-9j6210k6f7sf35.781w0017",
"email": "user1@example.com",
"password": "MyPassword123",
"credits": 12.45,
"name": "My Name User",
"key": "5d81h7a48bdbg1.347h4081"
}
]
|
POSTGEThttps://api.captchas.io/reseller/list_users
List registered users.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"total": 2
},
"users": [{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"credits": 12.45,
"name": "Example User1",
"key": "5d81h7a48bdbg1.347h4081"
},
{
"id": "usr-1c81h4a49bdbg1.843h4081",
"email": "user2@example.com",
"credits": 562.45,
"name": "Example User2",
"key": "1c81h4a49bdbg1.843h4081"
}]
]
|
POSTGEThttps://api.captchas.io/reseller/get_user
Get user profile.
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_key *
(user key)
|
The user's API key. 9j6210k6f7sf35.781w0017 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"password": "MyPassword123",
"credits": 12.45,
"name": "Example User1",
"key": "5d81h7a48bdbg1.347h4081"
}
]
|
POSTGEThttps://api.captchas.io/reseller/login_user
Login user account
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_email *
(user email address)
|
The user's registered email address. user@example.com |
|
user_password *
(user password)
|
The user's account password. MyPassword123 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"password": "MyPassword123",
"credits": 12.45,
"name": "Example User1",
"key": "5d81h7a48bdbg1.347h4081"
}
]
|
Complete CAPTCHA Solving Service Website
You can FORK or DOWNLOAD a complete working website using this API web service on GitHub. Please email admin@captchas.io or contact Glenn through skype: isnare.glenn for customization concerns.
Copyright © 2020 CAPTCHAs.IO Resellers - All rights reserved world-wide.