openapi_client

OpenapiClient - 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.

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
• Credit-Based System: Pay-per-use model with transparent pricing
• 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 credits

Authentication

All API endpoints require 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

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.0.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 'openapi_client', '~> 1.0.0'

Install from Git

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

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

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

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

# Load the gem
require 'openapi_client'

# Setup authorization
OpenapiClient.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 = OpenapiClient::ContentVerificationApi.new
project_id = 'proj-123' # String | Unique identifier for the project
verify_content_request = OpenapiClient::VerifyContentRequest.new({page_url: 'https://example.com/page', suggestion_id: 'sugg-123'}) # VerifyContentRequest | 

begin
  #Verify page content
  result = api_instance.verify_content(project_id, verify_content_request)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ContentVerificationApi->verify_content: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
OpenapiClient::ContentVerificationApi	verify_content	POST /api/projects/{projectId}/verify-content	Verify page content
OpenapiClient::CrawlingApi	get_crawl_history	GET /api/projects/{projectId}/crawl	Get crawl history
OpenapiClient::CrawlingApi	start_crawl	POST /api/projects/{projectId}/crawl	Start website crawl
OpenapiClient::CreditsApi	add_credits	POST /api/projects/{projectId}/credits	Add credits
OpenapiClient::CreditsApi	get_credits	GET /api/projects/{projectId}/credits	Get credit balance
OpenapiClient::ImplementationsApi	get_implementation	GET /api/projects/{projectId}/implementations/{implementationId}	Get implementation details
OpenapiClient::ImplementationsApi	implement_links	POST /api/projects/{projectId}/implementations	Implement link suggestions
OpenapiClient::ImplementationsApi	list_implementations	GET /api/projects/{projectId}/implementations	List implementations
OpenapiClient::ImplementationsApi	rollback_implementation	POST /api/projects/{projectId}/implementations/{implementationId}/rollback	Rollback implementation
OpenapiClient::ProjectsApi	create_project	POST /api/projects	Create a new project
OpenapiClient::ProjectsApi	delete_project	DELETE /api/projects/{projectId}	Delete a project
OpenapiClient::ProjectsApi	get_project	GET /api/projects/{projectId}	Get project details
OpenapiClient::ProjectsApi	list_projects	GET /api/projects	List all projects
OpenapiClient::SuggestionsApi	generate_suggestions	POST /api/projects/{projectId}/suggestions	Generate link suggestions
OpenapiClient::SuggestionsApi	get_suggestions	GET /api/projects/{projectId}/suggestions	Get link suggestions
OpenapiClient::SuggestionsApi	update_suggestion	PATCH /api/projects/{projectId}/suggestions/{suggestionId}	Update suggestion status
OpenapiClient::WebhooksApi	get_implementation_instructions	GET /api/webhook/implement-link	Get implementation instructions
OpenapiClient::WebhooksApi	report_implementation_status	POST /api/webhook/implement-link	Report implementation status

Documentation for Models

• OpenapiClient::AddCredits200Response
• OpenapiClient::AddCreditsRequest
• OpenapiClient::AutoRechargeSettings
• OpenapiClient::ChangeResult
• OpenapiClient::ContentVerification
• OpenapiClient::Crawl
• OpenapiClient::CreateProjectRequest
• OpenapiClient::CreditBalance
• OpenapiClient::CreditBalanceInfo
• OpenapiClient::CustomCredentials
• OpenapiClient::DeleteProject200Response
• OpenapiClient::Error
• OpenapiClient::GenerateSuggestions200Response
• OpenapiClient::GenerateSuggestionsRequest
• OpenapiClient::GetImplementation200Response
• OpenapiClient::Implementation
• OpenapiClient::ImplementationInstructions
• OpenapiClient::ImplementationRequest
• OpenapiClient::ImplementationResponse
• OpenapiClient::ImplementationResult
• OpenapiClient::ImplementationSummary
• OpenapiClient::LinkOpportunity
• OpenapiClient::ListImplementations200Response
• OpenapiClient::PageInfo
• OpenapiClient::PageLimitStatus
• OpenapiClient::PeriodCharges
• OpenapiClient::Project
• OpenapiClient::ProjectCount
• OpenapiClient::ReportImplementationStatus200Response
• OpenapiClient::ReportImplementationStatusRequest
• OpenapiClient::Rollback
• OpenapiClient::RollbackImplementation200Response
• OpenapiClient::RollbackImplementationRequest
• OpenapiClient::SpendingLimitStatus
• OpenapiClient::StartCrawlRequest
• OpenapiClient::StepByStepInstructions
• OpenapiClient::Suggestion
• OpenapiClient::UpdateSuggestionRequest
• OpenapiClient::UsageHistoryItem
• OpenapiClient::VerifyContent200Response
• OpenapiClient::VerifyContentRequest

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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