Skip to content

RankVectors/rust-sdk

Repository files navigation

Rust API client for rankvectors

Intelligent internal linking optimization API using AI.

RankVectors helps you automatically discover and implement optimal internal links across your website to improve SEO performance and user experience.

Key Features

  • AI-Powered Analysis: Uses OpenAI embeddings to find optimal linking opportunities
  • Smart Crawling: Automatically crawls and analyzes your website content
  • Automated Implementation: Implement links via webhooks or manual instructions
  • Page-Based Plans: Predictable pricing by number of pages monitored
  • Multi-Platform Support: Works with any CMS or platform via REST API

Getting Started

  1. Create a project with your website URL
  2. Start a crawl to analyze your content
  3. Generate AI-powered link suggestions
  4. Implement suggestions via API or webhook
  5. Track performance and manage page usage and limits

Authentication

Most API endpoints support authentication using your RankVectors API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your RankVectors dashboard: Settings → API Keys

Note: Some endpoints (marked in the documentation) support both API key authentication and web session authentication (Stack Auth). API key authentication is required for SDK usage and external integrations like WordPress plugins.

For more information, please visit https://rankvectors.com/docs

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.3.1
  • Package version: 1.3.1
  • Generator version: 7.16.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named rankvectors and add the following to Cargo.toml under [dependencies]:

rankvectors = { path = "./rankvectors" }

Documentation for API Endpoints

All URIs are relative to https://api.rankvectors.com

Class Method HTTP request Description
ApiKeysApi create_api_key POST /api/api-keys Create API key
ApiKeysApi delete_api_key DELETE /api/api-keys/{id} Delete API key
ApiKeysApi list_api_keys GET /api/api-keys List API keys
ApiKeysApi update_api_key PATCH /api/api-keys/{id} Update API key
AnalyticsApi get_project_analytics GET /api/projects/{projectId}/analytics Get project analytics
ContentVerificationApi get_page_changes GET /api/projects/{projectId}/changes Get page changes
ContentVerificationApi verify_content POST /api/projects/{projectId}/verify-content Verify page content
CrawlingApi get_crawl_history GET /api/projects/{projectId}/crawl Get crawl history
CrawlingApi start_crawl POST /api/projects/{projectId}/crawl Start website crawl
ImplementationsApi get_implementation GET /api/projects/{projectId}/implementations/{implementationId} Get implementation details
ImplementationsApi implement_links POST /api/projects/{projectId}/implementations Implement link suggestions
ImplementationsApi list_implementations GET /api/projects/{projectId}/implementations List implementations
ImplementationsApi rollback_implementation POST /api/projects/{projectId}/implementations/{implementationId}/rollback Rollback implementation
PagesApi batch_sync_pages POST /api/projects/{projectId}/pages/batch Batch sync pages
PagesApi list_pages GET /api/projects/{projectId}/pages List pages
ProjectsApi create_project POST /api/projects Create a new project
ProjectsApi delete_project DELETE /api/projects/{projectId} Delete a project
ProjectsApi get_project GET /api/projects/{projectId} Get project details
ProjectsApi list_projects GET /api/projects List all projects
ProjectsApi sync_project POST /api/projects/{projectId}/sync Sync project
SuggestionsApi delete_suggestion DELETE /api/projects/{projectId}/suggestions/{suggestionId} Delete suggestion
SuggestionsApi generate_suggestions POST /api/projects/{projectId}/suggestions Generate link suggestions
SuggestionsApi get_suggestions GET /api/projects/{projectId}/suggestions Get link suggestions
SuggestionsApi update_suggestion PATCH /api/projects/{projectId}/suggestions/{suggestionId} Update suggestion status
UserApi get_user_info GET /api/user/me Get authenticated user information
WebhooksApi get_implementation_instructions GET /api/webhook/implement-link Get implementation instructions
WebhooksApi report_implementation_status POST /api/webhook/implement-link Report implementation status

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

tj@rankvectors.com

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors