Module: FeratelCheckApiClient

Defined in:
lib/feratel-check-api-client/version.rb,
lib/feratel-check-api-client.rb,
lib/feratel-check-api-client/api_error.rb,
lib/feratel-check-api-client/api_client.rb,
lib/feratel-check-api-client/models/week.rb,
lib/feratel-check-api-client/configuration.rb,
lib/feratel-check-api-client/models/history.rb,
lib/feratel-check-api-client/models/customer.rb,
lib/feratel-check-api-client/models/age_group.rb,
lib/feratel-check-api-client/models/identifier.rb,
lib/feratel-check-api-client/models/check_point.rb,
lib/feratel-check-api-client/models/check_state.rb,
lib/feratel-check-api-client/models/check_result.rb,
lib/feratel-check-api-client/models/history_item.rb,
lib/feratel-check-api-client/models/service_type.rb,
lib/feratel-check-api-client/models/service_usage.rb,
lib/feratel-check-api-client/models/identification.rb,
lib/feratel-check-api-client/models/transact_error.rb,
lib/feratel-check-api-client/models/transact_state.rb,
lib/feratel-check-api-client/models/identifier_type.rb,
lib/feratel-check-api-client/models/transact_result.rb,
lib/feratel-check-api-client/api/check_resources_api.rb,
lib/feratel-check-api-client/models/check_point_item.rb,
lib/feratel-check-api-client/models/check_state_enum.rb,
lib/feratel-check-api-client/models/checkpoint_error.rb,
lib/feratel-check-api-client/models/service_provider.rb,
lib/feratel-check-api-client/api/system_resources_api.rb,
lib/feratel-check-api-client/models/check_point_group.rb,
lib/feratel-check-api-client/models/history_item_state.rb,
lib/feratel-check-api-client/models/service_usage_type.rb,
lib/feratel-check-api-client/models/identification_type.rb,
lib/feratel-check-api-client/models/transact_state_enum.rb,
lib/feratel-check-api-client/models/identification_usage.rb,
lib/feratel-check-api-client/models/age_group_translation.rb,
lib/feratel-check-api-client/models/identification_status.rb,
lib/feratel-check-api-client/models/valid_transaction_info.rb,
lib/feratel-check-api-client/models/check_state_translation.rb,
lib/feratel-check-api-client/models/service_type_assignment.rb,
lib/feratel-check-api-client/models/service_type_translation.rb,
lib/feratel-check-api-client/models/identification_usage_type.rb,
lib/feratel-check-api-client/models/transact_state_translation.rb

Overview

#CheckAPI Standard

#This documentation describes your available CheckAPI REST services: Get your checkpoints and their details, check the permission of a customer’s ID, take a look at your checkpoint’s history - everything a checkpoint needs can be found here in one place. Please look at the descriptions in each service below. <div id="authorize-information-wrap"><h1>Authorize</h1><p>You can use this automated authentication to try out your activated methods - just click „Authorize“, enter CardAPI credentials and have a try! You received the CardAPI username and password via e-mail – credentials are different from your developer-portal credentials. Authentication is based on OAUTH2 (implicit grant flow) and needs to be implemented and called prior to using any API method. CLIENT_ID
The client ID is pre-filled automatically according to the chosen application. You can find your available client IDs in the "Applications" - Area. GRANT_TYPE
With grant_type=password you get an access-token and a refresh-token for your request. The received access token can be used for 10 minutes, there are two ways to renew it. Either you can send the same request again or you can use the grant_type=refresh_token. The refresh token needs to be used every 30 minutes and can provide new access tokens for 10 hours without using your credentials.</p></div>

The version of the OpenAPI document: 1.17.0

Generated by: openapi-generator.tech Generator version: 7.8.0

Defined Under Namespace

Classes: AgeGroup, AgeGroupTranslation, ApiClient, ApiError, CheckPoint, CheckPointGroup, CheckPointItem, CheckResourcesApi, CheckResult, CheckState, CheckStateEnum, CheckStateTranslation, CheckpointError, Configuration, Customer, History, HistoryItem, HistoryItemState, Identification, IdentificationStatus, IdentificationType, IdentificationUsage, IdentificationUsageType, Identifier, IdentifierType, ServiceProvider, ServiceType, ServiceTypeAssignment, ServiceTypeTranslation, ServiceUsage, ServiceUsageType, SystemResourcesApi, TransactError, TransactResult, TransactState, TransactStateEnum, TransactStateTranslation, ValidTransactionInfo, Week

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

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

If no block given, return the default Configuration object.



67
68
69
70
71
72
73
 
# File 'lib/feratel-check-api-client.rb', line 67

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