rust-anticaptcha 0.2.4

Rust library for AntiCaptcha service API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! # TokenCaptcha module
//!
//! Module contains struct and functions to solve Token captcha,
//! like `ReCaptchaV2`, `ReCaptchaV3`, `FunCaptcha`, `GeeTest`, `Turnstile`.
//! Token captcha - captcha solved by tokens.
//!
//! ## Examples
//! ```no_run
//! use serde_json::json;
//!
//! use rust_anticaptcha::core::enums::TokenTaskType;
//! use rust_anticaptcha::token_captcha::TokenCaptcha;
//!
//! async fn run() {
//!     let map = json!({
//!                 "websiteKey": "6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u",
//!                 "websiteURL":"https://rucaptcha.com/demo/recaptcha-v2"
//!                 });
//!
//!     let mut image_to_text_client = TokenCaptcha::new("API_KEY".to_string());
//!     image_to_text_client.captcha_handler(TokenTaskType::RecaptchaV2TaskProxyless, &map).await;
//! }
//! ```

use serde_json::Value;

use super::core::captcha_interface::CaptchaInterface;
use super::core::enums::TokenTaskType;

/// Token captcha solving method - ReCaptchaV2, ReCaptchaV3, FunCaptcha, GeeTest, Turnstile.
///
/// # Examples
/// For `RecaptchaV2TaskProxyless`.
/// Other captcha types works same, you need check docs and set correct `task_payload`.
/// ```no_run
/// use serde_json::json;
///
/// use rust_anticaptcha::core::enums::TokenTaskType;
/// use rust_anticaptcha::token_captcha::TokenCaptcha;
///
/// async fn run() {
///     let map = json!({
///             "websiteKey": "6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u",
///             "websiteURL":"https://rucaptcha.com/demo/recaptcha-v2"
///         });
///
///     let mut image_to_text_client = TokenCaptcha::new("API_KEY".to_string());
///     image_to_text_client.captcha_handler(TokenTaskType::RecaptchaV2TaskProxyless, &map).await;
/// }
/// ```
///
/// # Notes
/// Read more here:
///
/// <https://anti-captcha.com/apidoc/task-types/RecaptchaV2TaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/RecaptchaV3TaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/RecaptchaV2EnterpriseTaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/RecaptchaV3Enterprise>
///
/// <https://anti-captcha.com/apidoc/task-types/FunCaptchaTaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/GeeTestTaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/TurnstileTaskProxyless>
///
/// <https://anti-captcha.com/apidoc/task-types/AntiGateTask>
///
pub struct TokenCaptcha {
    pub captcha_interface: CaptchaInterface,
}
impl TokenCaptcha {
    /// Method init new TokenCaptcha struct with Captcha Interface
    ///
    /// # Arguments
    /// `api_key` - Service API key
    ///
    /// # Examples
    ///
    /// ```
    /// use rust_anticaptcha::token_captcha::TokenCaptcha;
    ///
    /// let image_to_text_client = TokenCaptcha::new("API_KEY".to_string());
    /// ```
    /// # Returns
    /// Method return new `TokenCaptcha` instance
    ///
    pub fn new(api_key: String) -> Self {
        TokenCaptcha {
            captcha_interface: CaptchaInterface::new(api_key),
        }
    }

    /// Method run captcha solving logic
    ///
    /// # Arguments
    /// `captcha_type` - One of image captcha types from `TokenTaskType`
    /// `task_payload` - JSON with captcha task payload
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use serde_json::json;
    ///
    /// use rust_anticaptcha::core::enums::TokenTaskType;
    /// use rust_anticaptcha::token_captcha::TokenCaptcha;
    ///
    /// async fn run() {
    ///     let map = json!({
    ///             "websiteKey": "6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u",
    ///             "websiteURL":"https://rucaptcha.com/demo/recaptcha-v2"
    ///         });
    ///
    ///     let mut image_to_text_client = TokenCaptcha::new("API_KEY".to_string());
    ///     image_to_text_client.captcha_handler(TokenTaskType::RecaptchaV2TaskProxyless, &map).await;
    /// }
    /// ```
    pub async fn captcha_handler(
        &mut self,
        captcha_type: TokenTaskType,
        task_payload: &Value,
    ) -> Value {
        self.captcha_interface
            .solve_captcha(captcha_type, task_payload)
            .await
    }
}