Module: TCAClient

Defined in:
lib/tca_client/version.rb,
lib/tca_client.rb,
lib/tca_client/api_error.rb,
lib/tca_client/api_client.rb,
lib/tca_client/models/eula.rb,
lib/tca_client/api/eula_api.rb,
lib/tca_client/models/error.rb,
lib/tca_client/models/group.rb,
lib/tca_client/models/users.rb,
lib/tca_client/api/index_api.rb,
lib/tca_client/configuration.rb,
lib/tca_client/api/groups_api.rb,
lib/tca_client/models/sidebar.rb,
lib/tca_client/models/webhook.rb,
lib/tca_client/api/webhook_api.rb,
lib/tca_client/api/features_api.rb,
lib/tca_client/models/submission.rb,
lib/tca_client/api/similarity_api.rb,
lib/tca_client/api/submission_api.rb,
lib/tca_client/models/eula_version.rb,
lib/tca_client/models/webhook_base.rb,
lib/tca_client/models/group_context.rb,
lib/tca_client/models/webhook_all_of.rb,
lib/tca_client/models/aggregate_group.rb,
lib/tca_client/models/features_tenant.rb,
lib/tca_client/models/submission_base.rb,
lib/tca_client/models/success_message.rb,
lib/tca_client/models/features_enabled.rb,
lib/tca_client/models/rate_limit_error.rb,
lib/tca_client/models/indexing_settings.rb,
lib/tca_client/models/submission_all_of.rb,
lib/tca_client/models/viewer_permissions.rb,
lib/tca_client/models/eula_accept_request.rb,
lib/tca_client/models/features_similarity.rb,
lib/tca_client/models/pdf_status_response.rb,
lib/tca_client/models/similarity_metadata.rb,
lib/tca_client/models/similarity_settings.rb,
lib/tca_client/models/webhook_with_secret.rb,
lib/tca_client/models/annotations_settings.rb,
lib/tca_client/models/index_state_settings.rb,
lib/tca_client/models/request_pdf_response.rb,
lib/tca_client/models/webhook_path_request.rb,
lib/tca_client/models/eula_accept_list_item.rb,
lib/tca_client/models/features_viewer_modes.rb,
lib/tca_client/models/similarity_score_data.rb,
lib/tca_client/models/submission_size_error.rb,
lib/tca_client/models/similarity_put_request.rb,
lib/tca_client/models/generate_similarity_pdf.rb,
lib/tca_client/models/author_metadata_override.rb,
lib/tca_client/models/similarity_view_settings.rb,
lib/tca_client/models/submission_base_metadata.rb,
lib/tca_client/models/group_attachment_response.rb,
lib/tca_client/models/similarity_settings_modes.rb,
lib/tca_client/models/pdf_status_webhook_request.rb,
lib/tca_client/models/similarity_metadata_all_of.rb,
lib/tca_client/models/simple_submission_response.rb,
lib/tca_client/models/webhook_with_secret_all_of.rb,
lib/tca_client/models/add_group_attachment_request.rb,
lib/tca_client/models/features_generation_settings.rb,
lib/tca_client/models/add_group_attachment_response.rb,
lib/tca_client/models/similarity_generation_settings.rb,
lib/tca_client/models/similarity_viewer_url_response.rb,
lib/tca_client/models/similarity_viewer_url_settings.rb,
lib/tca_client/models/features_similarity_view_settings.rb,
lib/tca_client/models/get_group_attachments200_response.rb,
lib/tca_client/models/similarity_settings_view_settings.rb,
lib/tca_client/models/simple_submission_response_all_of.rb,
lib/tca_client/models/similarity_complete_webhook_request.rb,
lib/tca_client/models/submission_complete_webhook_request.rb,
lib/tca_client/models/similarity_metadata_all_of_top_matches.rb,
lib/tca_client/models/submission_complete_webhook_request_all_of.rb,
lib/tca_client/models/submission_complete_webhook_request_all_of_metadata.rb

Overview

#Turnitin Core API

#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an Admin user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click ‘Integrations` in the side bar –> `+ Add Integration` at top the top of the page –> Enter a name –> `Add` Button API Keys * Click `Integrations` in the side bar –> `Create API Key` Button next to a given Integration Scope –> Enter a name –> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the submission will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the report will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report

The version of the OpenAPI document: 1.0.258

Generated by: openapi-generator.tech OpenAPI Generator version: 6.3.0-SNAPSHOT

Defined Under Namespace

Classes: AddGroupAttachmentRequest, AddGroupAttachmentResponse, AggregateGroup, AnnotationsSettings, ApiClient, ApiError, AuthorMetadataOverride, Configuration, EULAApi, Error, Eula, EulaAcceptListItem, EulaAcceptRequest, EulaVersion, FeaturesApi, FeaturesEnabled, FeaturesGenerationSettings, FeaturesSimilarity, FeaturesSimilarityViewSettings, FeaturesTenant, FeaturesViewerModes, GenerateSimilarityPDF, GetGroupAttachments200Response, Group, GroupAttachmentResponse, GroupContext, GroupsApi, IndexApi, IndexStateSettings, IndexingSettings, PDFStatusWebhookRequest, PdfStatusResponse, RateLimitError, RequestPdfResponse, Sidebar, SimilarityApi, SimilarityCompleteWebhookRequest, SimilarityGenerationSettings, SimilarityMetadata, SimilarityMetadataAllOf, SimilarityMetadataAllOfTopMatches, SimilarityPutRequest, SimilarityScoreData, SimilaritySettings, SimilaritySettingsModes, SimilaritySettingsViewSettings, SimilarityViewSettings, SimilarityViewerUrlResponse, SimilarityViewerUrlSettings, SimpleSubmissionResponse, SimpleSubmissionResponseAllOf, Submission, SubmissionAllOf, SubmissionApi, SubmissionBase, SubmissionBaseMetadata, SubmissionCompleteWebhookRequest, SubmissionCompleteWebhookRequestAllOf, SubmissionCompleteWebhookRequestAllOfMetadata, SubmissionSizeError, SuccessMessage, Users, ViewerPermissions, Webhook, WebhookAllOf, WebhookApi, WebhookBase, WebhookPathRequest, WebhookWithSecret, WebhookWithSecretAllOf

Constant Summary collapse

VERSION = 
'1.0.4'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

TCAClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



98
99
100
101
102
103
104
 
# File 'lib/tca_client.rb', line 98

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end