Skip to content

WebhooksApi.md

Latest commit

 

History

History
155 lines (119 loc) · 5.43 KB

WebhooksApi.md

File metadata and controls

155 lines (119 loc) · 5.43 KB
Raw

WebhooksApi

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

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

getImplementationInstructions

ImplementationInstructions getImplementationInstructions(suggestionId)

Get implementation instructions

Get step-by-step instructions for implementing a link

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.WebhooksApi;

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");

    WebhooksApi apiInstance = new WebhooksApi(defaultClient);
    String suggestionId = "sugg-123"; // String | ID of the suggestion to implement
    try {
      ImplementationInstructions result = apiInstance.getImplementationInstructions(suggestionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhooksApi#getImplementationInstructions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
suggestionId String 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 -

reportImplementationStatus

ReportImplementationStatus200Response reportImplementationStatus(reportImplementationStatusRequest)

Report implementation status

Report the status of a link implementation

Example

// Import classes:
import com.rankvectors.ApiClient;
import com.rankvectors.ApiException;
import com.rankvectors.Configuration;
import com.rankvectors.auth.*;
import com.rankvectors.models.*;
import com.rankvectors.api.WebhooksApi;

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");

    WebhooksApi apiInstance = new WebhooksApi(defaultClient);
    ReportImplementationStatusRequest reportImplementationStatusRequest = new ReportImplementationStatusRequest(); // ReportImplementationStatusRequest | 
    try {
      ReportImplementationStatus200Response result = apiInstance.reportImplementationStatus(reportImplementationStatusRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WebhooksApi#reportImplementationStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reportImplementationStatusRequest 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 -