vgs_api_client 0.0.1.alpha202311162359 → 0.0.1.alpha202401251923
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/VERSION +1 -1
- data/api.yaml +23 -111
- data/lib/openapi_client/api/aliases_api.rb +10 -100
- data/lib/openapi_client/api_client.rb +2 -2
- data/lib/openapi_client/api_error.rb +1 -1
- data/lib/openapi_client/configuration.rb +1 -1
- data/lib/openapi_client/models/alias_format.rb +1 -4
- data/lib/openapi_client/models/create_aliases_request.rb +2 -2
- data/lib/openapi_client/models/create_aliases_request_new.rb +6 -2
- data/lib/openapi_client/models/create_aliases_request_reference.rb +6 -2
- data/lib/openapi_client/models/inline_response200.rb +1 -1
- data/lib/openapi_client/models/inline_response2001.rb +1 -1
- data/lib/openapi_client/models/inline_response201.rb +1 -1
- data/lib/openapi_client/models/inline_response_default.rb +1 -1
- data/lib/openapi_client/models/{alias_dto.rb → model_alias.rb} +4 -5
- data/lib/openapi_client/models/revealed_data.rb +2 -3
- data/lib/openapi_client/models/update_alias_request.rb +1 -1
- data/lib/openapi_client/models/update_alias_request_data.rb +1 -1
- data/lib/openapi_client/version.rb +2 -2
- data/lib/openapi_client.rb +2 -3
- data/lib/version.rb +1 -1
- data/lib/vgs_api_client.rb +1 -1
- data/scripts/assemble/run.sh +1 -1
- data/scripts/test/run.sh +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +3 -4
- data/lib/openapi_client/models/batch_aliases_request.rb +0 -264
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fdf9cff47010d5e6aec35df67b0d66b5eceb763633a1304c665cb8f5d8089c42
|
|
4
|
+
data.tar.gz: '0569561f883b0b755726cff22c0dd9c94e212b4e725b8c88188bd2b9b370a80c'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 32f92d2e61c6ffd167cf0149f302d1eff86704b6cadc557a6342e6cfed6e364bf93ddb11556c6e7079aefadb596d9c607ffcd3b312580777a830847c21e98932
|
|
7
|
+
data.tar.gz: d52e2996361723c6618373e10b1c66168649482f5d5699ddaaee61ee235d62760b9b69acf00d3850a1381ce00fd7ebd9dc644f558fb39e9af62828b032fae609
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.0.1.
|
|
1
|
+
0.0.1.alpha202401251923
|
data/api.yaml
CHANGED
|
@@ -24,26 +24,7 @@ info:
|
|
|
24
24
|
- [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started)
|
|
25
25
|
- [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
### Alias-Formats
|
|
30
|
-
| Format | Description |
|
|
31
|
-
|---------------------------------|-------------------------------------------------------------------------------------------|
|
|
32
|
-
| UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx |
|
|
33
|
-
| NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx |
|
|
34
|
-
| FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> |
|
|
35
|
-
| FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> |
|
|
36
|
-
| PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx |
|
|
37
|
-
| NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx |
|
|
38
|
-
| FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> |
|
|
39
|
-
| FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> |
|
|
40
|
-
| FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> |
|
|
41
|
-
| GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> |
|
|
42
|
-
| RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
|
|
43
|
-
| ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> |
|
|
44
|
-
| VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx |
|
|
45
|
-
|
|
46
|
-
## Authentication
|
|
27
|
+
### Authentication
|
|
47
28
|
|
|
48
29
|
This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam)
|
|
49
30
|
|
|
@@ -200,7 +181,7 @@ paths:
|
|
|
200
181
|
"classifiers": [
|
|
201
182
|
"email_address"
|
|
202
183
|
],
|
|
203
|
-
"format": "UUID"
|
|
184
|
+
"format": "UUID"
|
|
204
185
|
"storage": "VOLATILE"
|
|
205
186
|
}
|
|
206
187
|
]
|
|
@@ -220,7 +201,7 @@ paths:
|
|
|
220
201
|
manager or drop us a line at
|
|
221
202
|
[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
222
203
|
parameters:
|
|
223
|
-
- name:
|
|
204
|
+
- name: q
|
|
224
205
|
in: query
|
|
225
206
|
required: true
|
|
226
207
|
description: Comma-separated list of aliases to reveal.
|
|
@@ -228,14 +209,6 @@ paths:
|
|
|
228
209
|
- "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw,tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"
|
|
229
210
|
schema:
|
|
230
211
|
type: string
|
|
231
|
-
- name: storage
|
|
232
|
-
in: query
|
|
233
|
-
required: false
|
|
234
|
-
description: PERSISTENT or VOLATILE storage
|
|
235
|
-
example:
|
|
236
|
-
- "PERSISTENT"
|
|
237
|
-
schema:
|
|
238
|
-
type: string
|
|
239
212
|
responses:
|
|
240
213
|
'200':
|
|
241
214
|
description: OK
|
|
@@ -274,41 +247,12 @@ paths:
|
|
|
274
247
|
- lang: Shell
|
|
275
248
|
label: cURL
|
|
276
249
|
source: |
|
|
277
|
-
curl https://api.sandbox.verygoodvault.com/aliases?
|
|
250
|
+
curl https://api.sandbox.verygoodvault.com/aliases?q={{alias1}},{{alias2}} \
|
|
278
251
|
-u "$USERNAME:$PASSWORD"
|
|
279
252
|
|
|
280
|
-
/aliases/delete:
|
|
281
|
-
post:
|
|
282
|
-
summary: "Batch Delete Aliases"
|
|
283
|
-
operationId: "deleteAliases"
|
|
284
|
-
tags:
|
|
285
|
-
- aliases
|
|
286
|
-
description: |
|
|
287
|
-
Deletes multiple aliases.
|
|
288
|
-
requestBody:
|
|
289
|
-
content:
|
|
290
|
-
application/json:
|
|
291
|
-
schema:
|
|
292
|
-
$ref: "#/components/schemas/BatchAliasesRequest"
|
|
293
|
-
required: true
|
|
294
|
-
responses:
|
|
295
|
-
"204":
|
|
296
|
-
description: "No Content"
|
|
297
|
-
"404":
|
|
298
|
-
description: "Not Found"
|
|
299
|
-
x-codeSamples:
|
|
300
|
-
- lang: Shell
|
|
301
|
-
label: cURL
|
|
302
|
-
source: |
|
|
303
|
-
curl -v https://api.sandbox.verygoodvault.com/aliases/delete -d \
|
|
304
|
-
'{"storage":"VOLATILE","data":["tok_whjuj6F8r3f2KeCpY7RPCE"]}' \
|
|
305
|
-
-H 'Content-Type: application/json' \
|
|
306
|
-
-u "$USERNAME:$PASSWORD"
|
|
307
|
-
|
|
308
253
|
/aliases/{alias}:
|
|
309
254
|
parameters:
|
|
310
255
|
- $ref: '#/components/parameters/alias'
|
|
311
|
-
- $ref: '#/components/parameters/storage'
|
|
312
256
|
get:
|
|
313
257
|
operationId: revealAlias
|
|
314
258
|
tags:
|
|
@@ -323,7 +267,6 @@ paths:
|
|
|
323
267
|
[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
324
268
|
parameters:
|
|
325
269
|
- $ref: '#/components/parameters/alias'
|
|
326
|
-
- $ref: '#/components/parameters/storage'
|
|
327
270
|
responses:
|
|
328
271
|
'200':
|
|
329
272
|
description: OK
|
|
@@ -345,7 +288,7 @@ paths:
|
|
|
345
288
|
- lang: Shell
|
|
346
289
|
label: cURL
|
|
347
290
|
source: |
|
|
348
|
-
curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}
|
|
291
|
+
curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
|
|
349
292
|
-u "$USERNAME:$PASSWORD"
|
|
350
293
|
put:
|
|
351
294
|
operationId: updateAlias
|
|
@@ -389,7 +332,6 @@ paths:
|
|
|
389
332
|
Removes a single alias.
|
|
390
333
|
parameters:
|
|
391
334
|
- $ref: '#/components/parameters/alias'
|
|
392
|
-
- $ref: '#/components/parameters/storage'
|
|
393
335
|
responses:
|
|
394
336
|
'204':
|
|
395
337
|
description: No Content
|
|
@@ -399,7 +341,7 @@ paths:
|
|
|
399
341
|
- lang: Shell
|
|
400
342
|
label: cURL
|
|
401
343
|
source: |
|
|
402
|
-
curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}
|
|
344
|
+
curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
|
|
403
345
|
-X DELETE \
|
|
404
346
|
-u "$USERNAME:$PASSWORD"
|
|
405
347
|
|
|
@@ -423,16 +365,6 @@ components:
|
|
|
423
365
|
schema:
|
|
424
366
|
type: string
|
|
425
367
|
example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
|
|
426
|
-
storage:
|
|
427
|
-
name: "storage"
|
|
428
|
-
in: "query"
|
|
429
|
-
required: false
|
|
430
|
-
schema:
|
|
431
|
-
type: "string"
|
|
432
|
-
enum:
|
|
433
|
-
- "PERSISTENT"
|
|
434
|
-
- "VOLATILE"
|
|
435
|
-
default: "PERSISTENT"
|
|
436
368
|
|
|
437
369
|
responses:
|
|
438
370
|
ApiErrorsResponse:
|
|
@@ -482,14 +414,13 @@ components:
|
|
|
482
414
|
aliases:
|
|
483
415
|
type: "array"
|
|
484
416
|
items:
|
|
485
|
-
$ref: '#/components/schemas/
|
|
417
|
+
$ref: '#/components/schemas/Alias'
|
|
486
418
|
description: List of aliases associated with the value.
|
|
487
419
|
created_at:
|
|
488
420
|
type: "string"
|
|
489
421
|
format: "date-time"
|
|
490
422
|
description: Creation time, in UTC.
|
|
491
423
|
example: "2019-05-15T12:30:45Z"
|
|
492
|
-
nullable: true
|
|
493
424
|
storage:
|
|
494
425
|
type: string
|
|
495
426
|
enum:
|
|
@@ -501,7 +432,7 @@ components:
|
|
|
501
432
|
|
|
502
433
|
VOLATILE results in data being persisted into an in-memory data store for one hour which is required for PCI compliant storage of card security code data.
|
|
503
434
|
|
|
504
|
-
|
|
435
|
+
Alias:
|
|
505
436
|
type: "object"
|
|
506
437
|
properties:
|
|
507
438
|
alias:
|
|
@@ -510,48 +441,27 @@ components:
|
|
|
510
441
|
description: Opaque string used to substitute the raw value.
|
|
511
442
|
format:
|
|
512
443
|
$ref: '#/components/schemas/AliasFormat'
|
|
513
|
-
nullable: true
|
|
514
444
|
|
|
515
445
|
AliasFormat:
|
|
516
446
|
type: string
|
|
517
447
|
enum:
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
- "RAW_UUID"
|
|
531
|
-
- "UUID"
|
|
532
|
-
- "VGS_FIXED_LEN_GENERIC"
|
|
448
|
+
- FPE_ACC_NUM_T_FOUR
|
|
449
|
+
- FPE_ALPHANUMERIC_ACC_NUM_T_FOUR
|
|
450
|
+
- FPE_SIX_T_FOUR
|
|
451
|
+
- FPE_SSN_T_FOUR
|
|
452
|
+
- FPE_T_FOUR
|
|
453
|
+
- GENERIC_T_FOUR
|
|
454
|
+
- NON_LUHN_FPE_ALPHANUMERIC
|
|
455
|
+
- NUM_LENGTH_PRESERVING
|
|
456
|
+
- PFPT
|
|
457
|
+
- RAW_UUID
|
|
458
|
+
- UUID
|
|
459
|
+
- VGS_FIXED_LEN_GENERIC
|
|
533
460
|
description: |
|
|
534
461
|
Format of the generated alias string.
|
|
535
462
|
|
|
536
463
|
See [Alias Formats](#section/Introduction/Alias-Formats) for details.
|
|
537
464
|
example: UUID
|
|
538
|
-
nullable: true
|
|
539
|
-
|
|
540
|
-
BatchAliasesRequest:
|
|
541
|
-
type: "object"
|
|
542
|
-
properties:
|
|
543
|
-
data:
|
|
544
|
-
type: "array"
|
|
545
|
-
items:
|
|
546
|
-
type: "string"
|
|
547
|
-
storage:
|
|
548
|
-
type: "string"
|
|
549
|
-
enum:
|
|
550
|
-
- "PERSISTENT"
|
|
551
|
-
- "VOLATILE"
|
|
552
|
-
description: |
|
|
553
|
-
Format for batch requests (limit 20)
|
|
554
|
-
example: '{"data":["123-13123-1232"],"storage":"PERSISTENT"}'
|
|
555
465
|
|
|
556
466
|
CreateAliasesRequest:
|
|
557
467
|
type: object
|
|
@@ -559,7 +469,9 @@ components:
|
|
|
559
469
|
data:
|
|
560
470
|
type: array
|
|
561
471
|
items:
|
|
562
|
-
|
|
472
|
+
oneOf:
|
|
473
|
+
- $ref: '#/components/schemas/CreateAliasesRequestNew'
|
|
474
|
+
- $ref: '#/components/schemas/CreateAliasesRequestReference'
|
|
563
475
|
minItems: 1
|
|
564
476
|
maxItems: 20
|
|
565
477
|
required:
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Vault HTTP API
|
|
3
3
|
|
|
4
|
-
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)
|
|
4
|
+
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries) ### Authentication This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam) Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing. [Docs » Guides » Access credentials](https://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](https://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\": \"https://api.sandbox.verygoodvault.com/aliases\" } ] } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -87,7 +87,6 @@ module VgsApiClient
|
|
|
87
87
|
# Removes a single alias.
|
|
88
88
|
# @param _alias [String] Alias to operate on.
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
|
-
# @option opts [String] :storage (default to 'PERSISTENT')
|
|
91
90
|
# @return [nil]
|
|
92
91
|
def delete_alias(_alias, opts = {})
|
|
93
92
|
delete_alias_with_http_info(_alias, opts)
|
|
@@ -98,7 +97,6 @@ module VgsApiClient
|
|
|
98
97
|
# Removes a single alias.
|
|
99
98
|
# @param _alias [String] Alias to operate on.
|
|
100
99
|
# @param [Hash] opts the optional parameters
|
|
101
|
-
# @option opts [String] :storage
|
|
102
100
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
103
101
|
def delete_alias_with_http_info(_alias, opts = {})
|
|
104
102
|
if @api_client.config.debugging
|
|
@@ -108,16 +106,11 @@ module VgsApiClient
|
|
|
108
106
|
if @api_client.config.client_side_validation && _alias.nil?
|
|
109
107
|
fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.delete_alias"
|
|
110
108
|
end
|
|
111
|
-
allowable_values = ["PERSISTENT", "VOLATILE"]
|
|
112
|
-
if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
|
|
113
|
-
fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
|
|
114
|
-
end
|
|
115
109
|
# resource path
|
|
116
110
|
local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
|
|
117
111
|
|
|
118
112
|
# query parameters
|
|
119
113
|
query_params = opts[:query_params] || {}
|
|
120
|
-
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
|
121
114
|
|
|
122
115
|
# header parameters
|
|
123
116
|
header_params = opts[:header_params] || {}
|
|
@@ -153,77 +146,10 @@ module VgsApiClient
|
|
|
153
146
|
return data, status_code, headers
|
|
154
147
|
end
|
|
155
148
|
|
|
156
|
-
# Batch Delete Aliases
|
|
157
|
-
# Deletes multiple aliases.
|
|
158
|
-
# @param batch_aliases_request [BatchAliasesRequest]
|
|
159
|
-
# @param [Hash] opts the optional parameters
|
|
160
|
-
# @return [nil]
|
|
161
|
-
def delete_aliases(batch_aliases_request, opts = {})
|
|
162
|
-
delete_aliases_with_http_info(batch_aliases_request, opts)
|
|
163
|
-
nil
|
|
164
|
-
end
|
|
165
|
-
|
|
166
|
-
# Batch Delete Aliases
|
|
167
|
-
# Deletes multiple aliases.
|
|
168
|
-
# @param batch_aliases_request [BatchAliasesRequest]
|
|
169
|
-
# @param [Hash] opts the optional parameters
|
|
170
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
171
|
-
def delete_aliases_with_http_info(batch_aliases_request, opts = {})
|
|
172
|
-
if @api_client.config.debugging
|
|
173
|
-
@api_client.config.logger.debug 'Calling API: AliasesApi.delete_aliases ...'
|
|
174
|
-
end
|
|
175
|
-
# verify the required parameter 'batch_aliases_request' is set
|
|
176
|
-
if @api_client.config.client_side_validation && batch_aliases_request.nil?
|
|
177
|
-
fail ArgumentError, "Missing the required parameter 'batch_aliases_request' when calling AliasesApi.delete_aliases"
|
|
178
|
-
end
|
|
179
|
-
# resource path
|
|
180
|
-
local_var_path = '/aliases/delete'
|
|
181
|
-
|
|
182
|
-
# query parameters
|
|
183
|
-
query_params = opts[:query_params] || {}
|
|
184
|
-
|
|
185
|
-
# header parameters
|
|
186
|
-
header_params = opts[:header_params] || {}
|
|
187
|
-
# HTTP header 'Content-Type'
|
|
188
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
189
|
-
if !content_type.nil?
|
|
190
|
-
header_params['Content-Type'] = content_type
|
|
191
|
-
end
|
|
192
|
-
|
|
193
|
-
# form parameters
|
|
194
|
-
form_params = opts[:form_params] || {}
|
|
195
|
-
|
|
196
|
-
# http body (model)
|
|
197
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_aliases_request)
|
|
198
|
-
|
|
199
|
-
# return_type
|
|
200
|
-
return_type = opts[:debug_return_type]
|
|
201
|
-
|
|
202
|
-
# auth_names
|
|
203
|
-
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
204
|
-
|
|
205
|
-
new_options = opts.merge(
|
|
206
|
-
:operation => :"AliasesApi.delete_aliases",
|
|
207
|
-
:header_params => header_params,
|
|
208
|
-
:query_params => query_params,
|
|
209
|
-
:form_params => form_params,
|
|
210
|
-
:body => post_body,
|
|
211
|
-
:auth_names => auth_names,
|
|
212
|
-
:return_type => return_type
|
|
213
|
-
)
|
|
214
|
-
|
|
215
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
216
|
-
if @api_client.config.debugging
|
|
217
|
-
@api_client.config.logger.debug "API called: AliasesApi#delete_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
218
|
-
end
|
|
219
|
-
return data, status_code, headers
|
|
220
|
-
end
|
|
221
|
-
|
|
222
149
|
# Reveal single alias
|
|
223
150
|
# Retrieves a stored value along with its aliases. **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
224
151
|
# @param _alias [String] Alias to operate on.
|
|
225
152
|
# @param [Hash] opts the optional parameters
|
|
226
|
-
# @option opts [String] :storage (default to 'PERSISTENT')
|
|
227
153
|
# @return [InlineResponse2001]
|
|
228
154
|
def reveal_alias(_alias, opts = {})
|
|
229
155
|
data, _status_code, _headers = reveal_alias_with_http_info(_alias, opts)
|
|
@@ -234,7 +160,6 @@ module VgsApiClient
|
|
|
234
160
|
# Retrieves a stored value along with its aliases. **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
235
161
|
# @param _alias [String] Alias to operate on.
|
|
236
162
|
# @param [Hash] opts the optional parameters
|
|
237
|
-
# @option opts [String] :storage
|
|
238
163
|
# @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
|
|
239
164
|
def reveal_alias_with_http_info(_alias, opts = {})
|
|
240
165
|
if @api_client.config.debugging
|
|
@@ -244,16 +169,11 @@ module VgsApiClient
|
|
|
244
169
|
if @api_client.config.client_side_validation && _alias.nil?
|
|
245
170
|
fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.reveal_alias"
|
|
246
171
|
end
|
|
247
|
-
allowable_values = ["PERSISTENT", "VOLATILE"]
|
|
248
|
-
if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
|
|
249
|
-
fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
|
|
250
|
-
end
|
|
251
172
|
# resource path
|
|
252
173
|
local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
|
|
253
174
|
|
|
254
175
|
# query parameters
|
|
255
176
|
query_params = opts[:query_params] || {}
|
|
256
|
-
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
|
257
177
|
|
|
258
178
|
# header parameters
|
|
259
179
|
header_params = opts[:header_params] || {}
|
|
@@ -291,36 +211,33 @@ module VgsApiClient
|
|
|
291
211
|
|
|
292
212
|
# Reveal multiple aliases
|
|
293
213
|
# Given a list of aliases, retrieves all associated values stored in the vault. **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
294
|
-
# @param
|
|
214
|
+
# @param q [String] Comma-separated list of aliases to reveal.
|
|
295
215
|
# @param [Hash] opts the optional parameters
|
|
296
|
-
# @option opts [String] :storage PERSISTENT or VOLATILE storage
|
|
297
216
|
# @return [InlineResponse200]
|
|
298
|
-
def reveal_multiple_aliases(
|
|
299
|
-
data, _status_code, _headers = reveal_multiple_aliases_with_http_info(
|
|
217
|
+
def reveal_multiple_aliases(q, opts = {})
|
|
218
|
+
data, _status_code, _headers = reveal_multiple_aliases_with_http_info(q, opts)
|
|
300
219
|
data
|
|
301
220
|
end
|
|
302
221
|
|
|
303
222
|
# Reveal multiple aliases
|
|
304
223
|
# Given a list of aliases, retrieves all associated values stored in the vault. **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
|
|
305
|
-
# @param
|
|
224
|
+
# @param q [String] Comma-separated list of aliases to reveal.
|
|
306
225
|
# @param [Hash] opts the optional parameters
|
|
307
|
-
# @option opts [String] :storage PERSISTENT or VOLATILE storage
|
|
308
226
|
# @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
|
|
309
|
-
def reveal_multiple_aliases_with_http_info(
|
|
227
|
+
def reveal_multiple_aliases_with_http_info(q, opts = {})
|
|
310
228
|
if @api_client.config.debugging
|
|
311
229
|
@api_client.config.logger.debug 'Calling API: AliasesApi.reveal_multiple_aliases ...'
|
|
312
230
|
end
|
|
313
|
-
# verify the required parameter '
|
|
314
|
-
if @api_client.config.client_side_validation &&
|
|
315
|
-
fail ArgumentError, "Missing the required parameter '
|
|
231
|
+
# verify the required parameter 'q' is set
|
|
232
|
+
if @api_client.config.client_side_validation && q.nil?
|
|
233
|
+
fail ArgumentError, "Missing the required parameter 'q' when calling AliasesApi.reveal_multiple_aliases"
|
|
316
234
|
end
|
|
317
235
|
# resource path
|
|
318
236
|
local_var_path = '/aliases'
|
|
319
237
|
|
|
320
238
|
# query parameters
|
|
321
239
|
query_params = opts[:query_params] || {}
|
|
322
|
-
query_params[:'
|
|
323
|
-
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
|
240
|
+
query_params[:'q'] = q
|
|
324
241
|
|
|
325
242
|
# header parameters
|
|
326
243
|
header_params = opts[:header_params] || {}
|
|
@@ -360,7 +277,6 @@ module VgsApiClient
|
|
|
360
277
|
# Apply new classifiers to the value that the specified alias is associated with.
|
|
361
278
|
# @param _alias [String] Alias to operate on.
|
|
362
279
|
# @param [Hash] opts the optional parameters
|
|
363
|
-
# @option opts [String] :storage (default to 'PERSISTENT')
|
|
364
280
|
# @option opts [UpdateAliasRequest] :update_alias_request
|
|
365
281
|
# @return [nil]
|
|
366
282
|
def update_alias(_alias, opts = {})
|
|
@@ -372,7 +288,6 @@ module VgsApiClient
|
|
|
372
288
|
# Apply new classifiers to the value that the specified alias is associated with.
|
|
373
289
|
# @param _alias [String] Alias to operate on.
|
|
374
290
|
# @param [Hash] opts the optional parameters
|
|
375
|
-
# @option opts [String] :storage
|
|
376
291
|
# @option opts [UpdateAliasRequest] :update_alias_request
|
|
377
292
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
378
293
|
def update_alias_with_http_info(_alias, opts = {})
|
|
@@ -383,16 +298,11 @@ module VgsApiClient
|
|
|
383
298
|
if @api_client.config.client_side_validation && _alias.nil?
|
|
384
299
|
fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.update_alias"
|
|
385
300
|
end
|
|
386
|
-
allowable_values = ["PERSISTENT", "VOLATILE"]
|
|
387
|
-
if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
|
|
388
|
-
fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
|
|
389
|
-
end
|
|
390
301
|
# resource path
|
|
391
302
|
local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
|
|
392
303
|
|
|
393
304
|
# query parameters
|
|
394
305
|
query_params = opts[:query_params] || {}
|
|
395
|
-
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
|
396
306
|
|
|
397
307
|
# header parameters
|
|
398
308
|
header_params = opts[:header_params] || {}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Vault HTTP API
|
|
3
3
|
|
|
4
|
-
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)
|
|
4
|
+
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries) ### Authentication This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam) Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing. [Docs » Guides » Access credentials](https://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](https://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\": \"https://api.sandbox.verygoodvault.com/aliases\" } ] } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -31,7 +31,7 @@ module VgsApiClient
|
|
|
31
31
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
32
32
|
def initialize(config = Configuration.default)
|
|
33
33
|
@config = config
|
|
34
|
-
@user_agent = "vgs-api-client/0.0.1.
|
|
34
|
+
@user_agent = "vgs-api-client/0.0.1.alpha202401251923/ruby"
|
|
35
35
|
@default_headers = {
|
|
36
36
|
'Content-Type' => 'application/json',
|
|
37
37
|
'User-Agent' => @user_agent
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Vault HTTP API
|
|
3
3
|
|
|
4
|
-
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)
|
|
4
|
+
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries) ### Authentication This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam) Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing. [Docs » Guides » Access credentials](https://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](https://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\": \"https://api.sandbox.verygoodvault.com/aliases\" } ] } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Vault HTTP API
|
|
3
3
|
|
|
4
|
-
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)
|
|
4
|
+
#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](https://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](https://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](https://www.verygoodsecurity.com/docs/control). ## Learn about Tokenization - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries) ### Authentication This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam) Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing. [Docs » Guides » Access credentials](https://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](https://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\": \"https://api.sandbox.verygoodvault.com/aliases\" } ] } ```
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|