# rankvectors-python-sdk
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.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.3.1
- Package version: 1.3.1
- Generator version: 7.16.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://rankvectors.com/docs](https://rankvectors.com/docs)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/rankvectors/rankvectors-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/rankvectors/rankvectors-python-sdk.git`)

Then import the package:
```python
import rankvectors
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import rankvectors
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import rankvectors
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.APIKeysApi(api_client)
    create_api_key_request = rankvectors.CreateApiKeyRequest() # CreateApiKeyRequest | 

    try:
        # Create API key
        api_response = api_instance.create_api_key(create_api_key_request)
        print("The response of APIKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)

```

## Documentation for API Endpoints

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

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


## Documentation For Models

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


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author

tj@rankvectors.com


