Module: VgsApiClient

Defined in:
lib/vgs_api_client/version.rb,
lib/vgs_api_client.rb,
lib/vgs_api_client/api_error.rb,
lib/vgs_api_client/api_client.rb,
lib/vgs_api_client/configuration.rb,
lib/vgs_api_client/api/aliases_api.rb,
lib/vgs_api_client/models/api_error.rb,
lib/vgs_api_client/models/model_alias.rb,
lib/vgs_api_client/models/alias_format.rb,
lib/vgs_api_client/models/revealed_data.rb,
lib/vgs_api_client/models/inline_response200.rb,
lib/vgs_api_client/models/inline_response201.rb,
lib/vgs_api_client/models/inline_response2001.rb,
lib/vgs_api_client/models/update_alias_request.rb,
lib/vgs_api_client/models/create_aliases_request.rb,
lib/vgs_api_client/models/inline_response_default.rb,
lib/vgs_api_client/models/update_alias_request_data.rb,
lib/vgs_api_client/models/create_aliases_request_new.rb,
lib/vgs_api_client/models/create_aliases_request_reference.rb

Overview

#Vault HTTP API

#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault. The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication. ## What is VGS Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store. VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case. Tokenization is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](www.verygoodsecurity.com/docs/tokenization/getting-started). **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](www.verygoodsecurity.com/docs/getting-started/before-you-start). Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](www.verygoodsecurity.com/docs/tokenization/client-libraries) ### Authentication This API uses ‘Basic` authentication. Credentials to access the API can be generated on the [dashboard](dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing. [Docs » Guides » Access credentials](www.verygoodsecurity.com/docs/settings/access-credentials) ## Resource Limits ### Data Limits This API allows storing data up to 32MB in size. ### Rate Limiting The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request. Your current rate limit is included as HTTP headers in every API response: | Header Name | Description | |————————-|———————————————————-| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. | If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](developer.mozilla.org/en-US/docs/Web/HTTP/Status/429). ### Errors The API uses standard HTTP status codes to indicate whether the request succeeded or not. In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response: “`json { "errors": [ { "status": 400, "title": "Bad request", "detail": "Too many values (limit: 20)", "href": "api.sandbox.verygoodvault.com/aliases" } ] } “`

The version of the OpenAPI document: 1.0.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 5.4.0

Defined Under Namespace

Classes: AliasFormat, AliasesApi, ApiClient, ApiError, Configuration, CreateAliasesRequest, CreateAliasesRequestNew, CreateAliasesRequestReference, InlineResponse200, InlineResponse2001, InlineResponse201, InlineResponseDefault, ModelAlias, RevealedData, UpdateAliasRequest, UpdateAliasRequestData

Constant Summary collapse

VERSION = 
'0.0.35'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

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

If no block given, return the default Configuration object.



45
46
47
48
49
50
51
 
# File 'lib/vgs_api_client.rb', line 45

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