bing-webmaster-api 1.0.1

Rust client for the Bing Webmaster 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

# Bing Webmaster API Client

[<img alt="crates.io" src="https://img.shields.io/crates/v/bing-webmaster-api" height="20">](https://crates.io/crates/bing-webmaster-api)
[<img alt="docs.rs" src="https://img.shields.io/docsrs/bing-webmaster-api" height="20">](https://docs.rs/bing-webmaster-api)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/seo-meow/bing-webmaster-api/ci.yml?label=CI" height="20">](https://github.com/seo-meow/bing-webmaster-api/actions?query=branch%3Amaster)

A Rust client library for the [Bing Webmaster API](https://learn.microsoft.com/en-us/bingwebmaster/), providing access to all methods from Microsoft's Bing Webmaster Tools.

## Features

- **Complete API Coverage**: Implements all methods from the IWebmasterApi interface
- **Type-Safe**: Strongly typed request and response structures using serde
- **Async/Await**: Built with async/await support using reqwest and tokio
- **Middleware Support**: Built on reqwest-middleware for extensibility (retry, logging, etc.)
- **Tracing Support**: Instrumented with tracing for observability
- **Error Handling**: Uses anyhow for comprehensive error handling

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
bing-webmaster-api = "0.2.0"
tokio = { version = "1.0", features = ["full"] }
```

## Quick Start

```rust
use bing_webmaster_api::{WebmasterApiClient, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let client = WebmasterApiClient::new(
        "your-api-key".to_string(),
        None // Use default Bing API URL
    );

    // Add a site
    client.add_site("https://example.com").await?;

    // Submit a URL
    client.submit_url("https://example.com", "https://example.com/page1").await?;

    // Get crawl issues
    let issues = client.get_crawl_issues("https://example.com").await?;
    println!("Found {} URLs with crawl issues", issues.len());

    Ok(())
}
```

## Using with Middleware

The client supports `reqwest-middleware` for adding custom middleware like retry policies, logging, etc:

```rust
use bing_webmaster_api::{WebmasterApiClient, ClientBuilder, Result};
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<()> {
    // Create a client builder with custom middleware
    let client_builder = ClientBuilder::new(Client::new())
        // Add middleware here
        // .with(RetryTransientMiddleware::new_with_policy(retry_policy))
        ;

    let client = WebmasterApiClient::with_middleware(
        "your-api-key".to_string(),
        None,
        client_builder
    );

    // Use the client as normal
    client.add_site("https://example.com").await?;

    Ok(())
}
```

## Authentication

You'll need an API key from Bing Webmaster Tools:

1. Sign in to [Bing Webmaster Tools](https://www.bing.com/webmasters/)
2. Go to Settings > API Access
3. Generate an API key
4. Use the key with this client

## Rate Limits

- URL Submission: Up to 10,000 URLs per day
- Content Submission: Up to 10MB payload per request
- Check your quota with `get_content_submission_quota()`

## Examples

See the `examples/` directory for more usage examples.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under either of

- Apache License, Version 2.0
- MIT License

at your option.

## TODOs
- method `GetReqlatedKeywords`
- method `GetKeyword(String, String, String, DateTime, DateTime)`
- method `AddPagePreviewBlock(String, String, BlockReason)`
- method `RemovePagePreviewBlock(String, String)`
- method `GetActivePagePreviewBlocks(String)`
- method `SubmitSiteMove(String, SiteMoveSettings)`
- method `GetSiteMoves(String)`
- method `AddBlockedUrl(String, BlockedUrl)`
- method `GetBlockedUrls(String)`
- method `RemoveBlockedUrl(String, BlockedUrl)`
- method `AddDeepLinkBlock(String, String, String, String)`
- method `GetDeepLinkBlocks(String)`
- method `RemoveDeepLinkBlock(String, String, String, String)`