Skip to content

ImplementationsApi.md

Latest commit

 

History

History
375 lines (264 loc) · 13.7 KB

ImplementationsApi.md

File metadata and controls

375 lines (264 loc) · 13.7 KB

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

GetImplementation200Response get_implementation(project_id, implementation_id)

Get implementation details

Get detailed information about a specific implementation

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.get_implementation200_response import GetImplementation200Response
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.ImplementationsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    implementation_id = 'impl-123' # str | Unique identifier for the implementation

    try:
        # Get implementation details
        api_response = api_instance.get_implementation(project_id, implementation_id)
        print("The response of ImplementationsApi->get_implementation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImplementationsApi->get_implementation: %s\n" % e)

Parameters

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

Return type

GetImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Implementation details -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

implement_links

ImplementationResponse implement_links(project_id, implementation_request)

Implement link suggestions

Implement one or more link suggestions

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.implementation_request import ImplementationRequest
from rankvectors.models.implementation_response import ImplementationResponse
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.ImplementationsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    implementation_request = {"suggestionIds":["sugg-123"],"platform":"custom","credentials":{"webhookUrl":"https://yourapi.com/rankvectors-webhook","apiKey":"your-webhook-secret-key"}} # ImplementationRequest | 

    try:
        # Implement link suggestions
        api_response = api_instance.implement_links(project_id, implementation_request)
        print("The response of ImplementationsApi->implement_links:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImplementationsApi->implement_links: %s\n" % e)

Parameters

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

Return type

ImplementationResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Implementation results -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_implementations

ListImplementations200Response list_implementations(project_id, status=status, platform=platform, limit=limit, offset=offset)

List implementations

Get implementation history for a project

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.list_implementations200_response import ListImplementations200Response
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.ImplementationsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    status = 'status_example' # str | Filter by implementation status (optional)
    platform = 'platform_example' # str | Filter by platform (optional)
    limit = 50 # int | Results per page (optional) (default to 50)
    offset = 0 # int | Pagination offset (optional) (default to 0)

    try:
        # List implementations
        api_response = api_instance.list_implementations(project_id, status=status, platform=platform, limit=limit, offset=offset)
        print("The response of ImplementationsApi->list_implementations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImplementationsApi->list_implementations: %s\n" % e)

Parameters

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

Return type

ListImplementations200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Implementation history -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rollback_implementation

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

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.rollback_implementation200_response import RollbackImplementation200Response
from rankvectors.models.rollback_implementation_request import RollbackImplementationRequest
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.ImplementationsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    implementation_id = 'impl-123' # str | Unique identifier for the implementation
    rollback_implementation_request = rankvectors.RollbackImplementationRequest() # RollbackImplementationRequest | 

    try:
        # Rollback implementation
        api_response = api_instance.rollback_implementation(project_id, implementation_id, rollback_implementation_request)
        print("The response of ImplementationsApi->rollback_implementation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImplementationsApi->rollback_implementation: %s\n" % e)

Parameters

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

Return type

RollbackImplementation200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Rollback successful -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]