Skip to content

ContentVerificationApi.md

Latest commit

 

History

History
85 lines (65 loc) · 2.95 KB

ContentVerificationApi.md

File metadata and controls

85 lines (65 loc) · 2.95 KB
Raw

ContentVerificationApi

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

Method HTTP request Description
verifyContent POST /api/projects/{projectId}/verify-content Verify page content

verifyContent

VerifyContent200Response verifyContent(projectId, verifyContentRequest)

Verify page content

Check if page content has changed since last crawl

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.ContentVerificationApi;

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

    ContentVerificationApi apiInstance = new ContentVerificationApi(defaultClient);
    String projectId = "proj-123"; // String | Unique identifier for the project
    VerifyContentRequest verifyContentRequest = new VerifyContentRequest(); // VerifyContentRequest | 
    try {
      VerifyContent200Response result = apiInstance.verifyContent(projectId, verifyContentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentVerificationApi#verifyContent");
      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
projectId String Unique identifier for the project
verifyContentRequest VerifyContentRequest

Return type

VerifyContent200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Content verification result -
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 -