AutoSolveClient 1.0.2

AYCD AutoSolve C# Client

Client for connecting to the AYCD AutoSolve network

Getting Started

For an example instantiation, take a look at testclient.cs.

Dependencies

Nuget packages auto-installed with client:

PubSub (>= 4.0.0)
RabbitMQ.Client (>= 5.1.2)
System.Collections.NonGeneric (>= 4.3.0)
System.Json (>= 4.7.0)
System.Runtime.Serialization.Json (>= 4.3.0)
System.Text.Json (>= 4.7.1)

Initialization

Integrate in a few simple steps. First, install the NuGet package in package manager, by searching for:

AutoSolveClient

Then, import the module into your application:

using AutoSolveClient

Next, instantiate the AutoSolve class.

AutoSolve client = new AutoSolve(
    "accessToken",
    "apiKey",
    "clientId",
    debug (boolean)
)

Where:

• accessToken is the user's access token
• apiKey is the user's api key generated for your program
• clientKey is the unique client identifier given to you by AYCD
• debug enables more thorough console logging for actions occuring. True for logging

To better integrate with your logging, debug emits an event (if true) to a listener, which you must create. An example:

this.client.ee.Subscribe<String>(message =>
{
    //do what you want with the message here.
	Console.WriteLine(message)
});

Then, you must create an event listener to handle responses sent from AutoSolve.

An example listener:

this.client.ee.Subscribe<AutoSolveResponse>(responseObject =>
{
	handleAutosolveResponse(responseObject)
});


void handleAutosolveResponse(AutoSolveResponse responseObject) {
    Console.WriteLine("Task ID :: " + responseObject.taskId)
    Console.WriteLine("Site Key :: " + responseObject.siteKey)
    Console.WriteLine("Token :: " + responseObject.token)
    Console.WriteLine("Created At :: " + responseObject.createdAt)
    Console.WriteLine("Version :: " + responseObject.version)
    Console.WriteLine("Action :: " + responseObject.action)
}

Finally, you can now begin instantiating connections to AutoSolve by calling:

client.Init();

Request Data

You must send requests in the following format, using the AutoSolveMessage class get/set instantiatiors:

AutoSolveMessage message = new AutoSolveMessage() 
{
    //An ID for the task requesting captcha. This can be whatever.
    taskId = "task1", 

    //Url of the site which the captcha was received
    url = "https://recaptcha.autosolve.io/version/1", 

    //Public ReCaptcha key for a given site
    siteKey = "6Ld_LMAUAAAAAOIqLSy5XY9-DUKLkAgiDpqtTJ9b", 

    //Api Key your customer needs from AYCD Autosolve
    apiKey = autoSolve.apiKey, 

    //Map object for parameters for ReCaptcha v2, in the grecaptcha.render method
    renderParameters = renderMap

    //Version of ReCaptcha
    //Options:
    /**
        V2_CHECKBOX is 0
        V2_INVISIBLE is 1
        V3_SCORE is 2
        */
    version = "0", 

    //Only required for ReCaptcha V3. Site-specific value. More info:
    //https://developers.google.com/recaptcha/docs/v3#actions
    action = "", 

    //Minimum score required to pass the recaptcha
    minScore = 0, 

    //Proxy used in the task which got the captcha
    proxy = "", 

    //Is proxy required, some captcha services don't support use of proxies
    //and will not be used if a proxy is necessary for captcha processing.
    //Default is false
    proxyRequired = false,

    //User agent used in the request (optional)
    userAgent = "",

    //Cookies in the request (optional)
    cookies = ""
}

Handling Responses

You will receive responses as an AutoSolveResponse object, with the following fields :

{
    taskId
    siteKey
    token
    createdAt
    version
    action
}

Sending Requests

Lastly, to send a request, use the following function, where message is of type AutoSolveMessage:

AutoSolveMessage message = new AutoSolveMessage() { taskId = "3", url = "https://google.com", ... }
client.sendMessage(message)

This will return true if successful, or false if unsuccessful. It is blocking and should be handled on another thread if possible. In the case that it is unsuccessful, use the following which will wait, attempt resend, and if failed push the message to a backlog to resend upon reconnection:

Error Handling

AutoSolve C# has automatic error handling and recovery, but will throw an exception if:

• Client Key is invalid
• API Key is invalid
• Access Token is invalid
• Connection error occurs AND recovery is not possible

Errors will be thrown as error object class AutoSolveException, with the following types:

• INVALID_CLIENT_ID
• INVALID_API_KEY_OR_ACCESS_TOKEN
• INPUT_VALUE_ERROR

License

This project is licensed under the MIT License