Rest APIs
This section provides details about REST APIs, and how to use and deploy the REST APIs.
Note
The user may use the obfuscated password or credential. See Creating Obfuscated Data Using Obfuscation Utility for more information.
DbUser and DbPassword parameters are optional only when token service auth utility is used.
The REST API works with CXF jar and Apache Tomcat server, and enables developers to integrate the CT-V methods described below:
insertToken(): create tokens and insert them into a Token Vault, including Unicode (multibyte) tokens.
insertIrreversibleToken(): create irreversible tokens and insert them into a Token Vault, including Unicode (multibyte) tokens.
insertTokenBatchWithMultipleVault(): create tokens and insert them into multiple Token Vaults.
insertTokenWithTokenProperty(): create tokens and insert them into a Token Vault along with the tokenProperty, including Unicode (multibyte) tokens.
insertTokenWithTokenPropertyBatch(): create tokens and inserts them into a Token Vault along with tokenProperty corresponding to each token.
getToken(): check if a token exists in the token vault.
getByTokenProperty(): check on the basis of tokenProperty if a token exists in the token vault.
getCustomTokenProperty(): get an array of customTokenProperty for the specified tokens.
getCustomTokenPropertyByValue(): get an array of customTokenProperty for the specified plaintext value(s) and custom data.
getValue(): get plaintext values.
getDisabledTokens(): get disabled tokens from the token vault.
deleteToken(): deletes the tokens.
deleteValue(): deletes tokens based on plaintext value.
disableToken(): disables tokens from a token vault.
deleteTokenByTokenProperty(): delete tokens based on tokenProperty.
getTokenByDate(): retrieve up to 10,000 tokens created on or before a specific date.
getTokenByRangeDate(): retrieve up to 10,000 tokens created between a specific date range.
mask(): create tokens without inserting them into a Token Vault.
createTokenFormat(): create new token formats.
createTokenFormatWithRegEx(): create a new token format that can be used with the insertToken method.
createTokenFormatWithRandomTokenLength(): create token with a particular token length.
createMaskingFormat(): create new masking formats to mask the plaintext values.
updateTokenProperty(): update token property for tokens.
