rankvectors

RankVectors - the Ruby gem for the RankVectors API

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.

• 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

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

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.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.3.1
• Package version: 1.3.1
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://rankvectors.com/docs

To build the Ruby code into a gem:

gem build rankvectors.gemspec

Then either install the gem locally:

gem install ./rankvectors-1.3.1.gem

(for development, run gem install --dev ./rankvectors-1.3.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'rankvectors', '~> 1.3.1'

If the Ruby gem is hosted at a git repository: https://github.com/rankvectors/rankvectors-ruby-sdk, then add the following in the Gemfile:

gem 'rankvectors', :git => 'https://github.com/rankvectors/rankvectors-ruby-sdk.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'rankvectors'

# Setup authorization
RankVectors.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = RankVectors::APIKeysApi.new
create_api_key_request = RankVectors::CreateApiKeyRequest.new({name: 'WordPress Plugin'}) # CreateApiKeyRequest | 

begin
  #Create API key
  result = api_instance.create_api_key(create_api_key_request)
  p result
rescue RankVectors::ApiError => e
  puts "Exception when calling APIKeysApi->create_api_key: #{e}"
end

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

• RankVectors::ApiKey
• RankVectors::ApiKeyResponse
• RankVectors::BatchSyncPages200Response
• RankVectors::BatchSyncPagesRequest
• RankVectors::ChangeResult
• RankVectors::ContentVerification
• RankVectors::Crawl
• RankVectors::CreateApiKeyRequest
• RankVectors::CreateProjectRequest
• RankVectors::CustomCredentials
• RankVectors::DeleteProject200Response
• RankVectors::DeleteSuggestion200Response
• RankVectors::Error
• RankVectors::GenerateSuggestions200Response
• RankVectors::GenerateSuggestionsRequest
• RankVectors::GetImplementation200Response
• RankVectors::GetPageChanges200Response
• RankVectors::GetPageChanges200ResponseSummary
• RankVectors::GetUserInfo200Response
• RankVectors::GetUserInfo200ResponseLinks
• RankVectors::GetUserInfo200ResponseUser
• RankVectors::Implementation
• RankVectors::ImplementationInstructions
• RankVectors::ImplementationRequest
• RankVectors::ImplementationResponse
• RankVectors::ImplementationResult
• RankVectors::ImplementationSummary
• RankVectors::LinkOpportunity
• RankVectors::ListImplementations200Response
• RankVectors::ListPages200Response
• RankVectors::Page
• RankVectors::PageAllowance
• RankVectors::PageAllowanceInfo
• RankVectors::PageAllowanceUsageHistoryInner
• RankVectors::PageChange
• RankVectors::PageChangePage
• RankVectors::PageData
• RankVectors::PageInfo
• RankVectors::PageLimitStatus
• RankVectors::PagePricing
• RankVectors::PagePricingPagePacksInner
• RankVectors::PagePricingTiersInner
• RankVectors::PeriodCharges
• RankVectors::Project
• RankVectors::ProjectAnalytics
• RankVectors::ProjectAnalyticsContentStats
• RankVectors::ProjectAnalyticsImplementationStats
• RankVectors::ProjectAnalyticsSuggestionStats
• RankVectors::ProjectAnalyticsSyncStats
• RankVectors::ProjectCount
• RankVectors::ReportImplementationStatus200Response
• RankVectors::ReportImplementationStatusRequest
• RankVectors::Rollback
• RankVectors::RollbackImplementation200Response
• RankVectors::RollbackImplementationRequest
• RankVectors::StartCrawlRequest
• RankVectors::StepByStepInstructions
• RankVectors::Suggestion
• RankVectors::SyncProject200Response
• RankVectors::SyncProjectRequest
• RankVectors::UpdateApiKeyRequest
• RankVectors::UpdateSuggestionRequest
• RankVectors::UsageHistoryItem
• RankVectors::VerifyContent200Response
• RankVectors::VerifyContentRequest

Authentication schemes defined for the API:

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header