Skip to content

ImplementationsApi.md

Latest commit

 

History

History
313 lines (226 loc) · 10.3 KB

ImplementationsApi.md

File metadata and controls

313 lines (226 loc) · 10.3 KB
Raw

RankVectors::ImplementationsApi

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

Method HTTP request Description
get_implementation GET /api/projects/{projectId}/implementations/{implementationId} Get implementation details
implement_links POST /api/projects/{projectId}/implementations Implement link suggestions
list_implementations GET /api/projects/{projectId}/implementations List implementations
rollback_implementation POST /api/projects/{projectId}/implementations/{implementationId}/rollback Rollback implementation

get_implementation

get_implementation(project_id, implementation_id)

Get implementation details

Get detailed information about a specific implementation

Examples

require 'time'
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::ImplementationsApi.new
project_id = 'proj-123' # String | Unique identifier for the project
implementation_id = 'impl-123' # String | Unique identifier for the implementation

begin
  # Get implementation details
  result = api_instance.get_implementation(project_id, implementation_id)
  p result
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->get_implementation: #{e}"
end

Using the get_implementation_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_implementation_with_http_info(project_id, implementation_id)

begin
  # Get implementation details
  data, status_code, headers = api_instance.get_implementation_with_http_info(project_id, implementation_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetImplementation200Response>
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->get_implementation_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_id String Unique identifier for the project
implementation_id String Unique identifier for the implementation

Return type

GetImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

implement_links

implement_links(project_id, implementation_request)

Implement link suggestions

Implement one or more link suggestions

Examples

require 'time'
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::ImplementationsApi.new
project_id = 'proj-123' # String | Unique identifier for the project
implementation_request = RankVectors::ImplementationRequest.new({suggestion_ids: ["sugg-1", "sugg-2"], platform: 'custom', credentials: RankVectors::CustomCredentials.new({webhook_url: 'https://yourapi.com/rankvectors-webhook', api_key: 'your-webhook-secret-key'})}) # ImplementationRequest | 

begin
  # Implement link suggestions
  result = api_instance.implement_links(project_id, implementation_request)
  p result
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->implement_links: #{e}"
end

Using the implement_links_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> implement_links_with_http_info(project_id, implementation_request)

begin
  # Implement link suggestions
  data, status_code, headers = api_instance.implement_links_with_http_info(project_id, implementation_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImplementationResponse>
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->implement_links_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_id String Unique identifier for the project
implementation_request ImplementationRequest

Return type

ImplementationResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

list_implementations

list_implementations(project_id, opts)

List implementations

Get implementation history for a project

Examples

require 'time'
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::ImplementationsApi.new
project_id = 'proj-123' # String | Unique identifier for the project
opts = {
  status: 'pending', # String | Filter by implementation status
  platform: 'custom', # String | Filter by platform
  limit: 56, # Integer | Results per page
  offset: 56 # Integer | Pagination offset
}

begin
  # List implementations
  result = api_instance.list_implementations(project_id, opts)
  p result
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->list_implementations: #{e}"
end

Using the list_implementations_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_implementations_with_http_info(project_id, opts)

begin
  # List implementations
  data, status_code, headers = api_instance.list_implementations_with_http_info(project_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListImplementations200Response>
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->list_implementations_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_id String Unique identifier for the project
status String Filter by implementation status [optional]
platform String Filter by platform [optional]
limit Integer Results per page [optional][default to 50]
offset Integer Pagination offset [optional][default to 0]

Return type

ListImplementations200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

rollback_implementation

rollback_implementation(project_id, implementation_id, rollback_implementation_request)

Rollback implementation

Undo a link implementation and restore original content. Rollback is universally available for all platforms: - WordPress (via custom/webhook) - Shopify (direct API) - Vercel (via custom/webhook) - Webflow (via custom/webhook) - Contentful (via custom/webhook) - Custom (via webhook) The rollback process restores the original content that was stored during implementation.

Examples

require 'time'
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::ImplementationsApi.new
project_id = 'proj-123' # String | Unique identifier for the project
implementation_id = 'impl-123' # String | Unique identifier for the implementation
rollback_implementation_request = RankVectors::RollbackImplementationRequest.new # RollbackImplementationRequest | 

begin
  # Rollback implementation
  result = api_instance.rollback_implementation(project_id, implementation_id, rollback_implementation_request)
  p result
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->rollback_implementation: #{e}"
end

Using the rollback_implementation_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> rollback_implementation_with_http_info(project_id, implementation_id, rollback_implementation_request)

begin
  # Rollback implementation
  data, status_code, headers = api_instance.rollback_implementation_with_http_info(project_id, implementation_id, rollback_implementation_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RollbackImplementation200Response>
rescue RankVectors::ApiError => e
  puts "Error when calling ImplementationsApi->rollback_implementation_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
project_id String Unique identifier for the project
implementation_id String Unique identifier for the implementation
rollback_implementation_request RollbackImplementationRequest

Return type

RollbackImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json