Skip to content

WebhooksApi.md

Latest commit

 

History

History
176 lines (120 loc) · 6.12 KB

WebhooksApi.md

File metadata and controls

176 lines (120 loc) · 6.12 KB

rankvectors.WebhooksApi

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

Method HTTP request Description
get_implementation_instructions GET /api/webhook/implement-link Get implementation instructions
report_implementation_status POST /api/webhook/implement-link Report implementation status

get_implementation_instructions

ImplementationInstructions get_implementation_instructions(suggestion_id)

Get implementation instructions

Get step-by-step instructions for implementing a link

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.implementation_instructions import ImplementationInstructions
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.WebhooksApi(api_client)
    suggestion_id = 'sugg-123' # str | ID of the suggestion to implement

    try:
        # Get implementation instructions
        api_response = api_instance.get_implementation_instructions(suggestion_id)
        print("The response of WebhooksApi->get_implementation_instructions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->get_implementation_instructions: %s\n" % e)

Parameters

Name Type Description Notes
suggestion_id str ID of the suggestion to implement

Return type

ImplementationInstructions

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Implementation instructions -
400 Bad request - invalid parameters -
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]

report_implementation_status

ReportImplementationStatus200Response report_implementation_status(report_implementation_status_request)

Report implementation status

Report the status of a link implementation

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.report_implementation_status200_response import ReportImplementationStatus200Response
from rankvectors.models.report_implementation_status_request import ReportImplementationStatusRequest
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.WebhooksApi(api_client)
    report_implementation_status_request = rankvectors.ReportImplementationStatusRequest() # ReportImplementationStatusRequest | 

    try:
        # Report implementation status
        api_response = api_instance.report_implementation_status(report_implementation_status_request)
        print("The response of WebhooksApi->report_implementation_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebhooksApi->report_implementation_status: %s\n" % e)

Parameters

Name Type Description Notes
report_implementation_status_request ReportImplementationStatusRequest

Return type

ReportImplementationStatus200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Status reported successfully -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
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]