openapi-java-client

RankVectors API

• API version: 1.2.0
  • Build date: 2025-10-26T23:58:45.692034+05:30[Asia/Kolkata]
  • Generator version: 7.16.0

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

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.2.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:openapi-java-client:1.2.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-1.2.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.model.*;
import com.rankvectors.api.ContentVerificationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rankvectors.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    ContentVerificationApi apiInstance = new ContentVerificationApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    VerifyContentRequest verifyContentRequest = new VerifyContentRequest(); // VerifyContentRequest | 
    try {
      VerifyContent200Response result = apiInstance.verifyContent(projectId, verifyContentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentVerificationApi#verifyContent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentVerificationApi	verifyContent	POST /api/projects/{projectId}/verify-content	Verify page content
CrawlingApi	getCrawlHistory	GET /api/projects/{projectId}/crawl	Get crawl history
CrawlingApi	startCrawl	POST /api/projects/{projectId}/crawl	Start website crawl
CreditsApi	addCredits	POST /api/projects/{projectId}/credits	Add credits
CreditsApi	getCredits	GET /api/projects/{projectId}/credits	Get credit balance
ImplementationsApi	getImplementation	GET /api/projects/{projectId}/implementations/{implementationId}	Get implementation details
ImplementationsApi	implementLinks	POST /api/projects/{projectId}/implementations	Implement link suggestions
ImplementationsApi	listImplementations	GET /api/projects/{projectId}/implementations	List implementations
ImplementationsApi	rollbackImplementation	POST /api/projects/{projectId}/implementations/{implementationId}/rollback	Rollback implementation
ProjectsApi	createProject	POST /api/projects	Create a new project
ProjectsApi	deleteProject	DELETE /api/projects/{projectId}	Delete a project
ProjectsApi	getProject	GET /api/projects/{projectId}	Get project details
ProjectsApi	listProjects	GET /api/projects	List all projects
SuggestionsApi	generateSuggestions	POST /api/projects/{projectId}/suggestions	Generate link suggestions
SuggestionsApi	getSuggestions	GET /api/projects/{projectId}/suggestions	Get link suggestions
SuggestionsApi	updateSuggestion	PATCH /api/projects/{projectId}/suggestions/{suggestionId}	Update suggestion status
WebhooksApi	getImplementationInstructions	GET /api/webhook/implement-link	Get implementation instructions
WebhooksApi	reportImplementationStatus	POST /api/webhook/implement-link	Report implementation status

Documentation for Models

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

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

tj@rankvectors.com