API Tokens

API Tokens - This page will allow you to setup 1 to many encrypted API Tokens for access to XDOC that defines the encryption for the tokens on the Web API Services screen. Configuration of these options may require assistance from XDOC Customer Support. Configuration of these options may require assistance from XDOC Customer Support. 

Note: The original API Token Crypto that was located on the Web API Services screen will default as the 1st API Token configuration.

Creating a new API Token

  1. Click Create from the top of the grid.
  2. The Token Set Editor screen will appear.
  3. Fill out all required information (see table below).
  4. Click Save to close or Save and New to create another API Token.

 

Field

 Value
Active Indicator if the API Token is in use.
Name User-defined Token name.
Encryption Class Currently there is only one choice from the dropdown, AES.
Encryption Key Enter the Encryption Key, if any. 
Key Size (Bits)

Choose the appropriate key size from the dropdown. The number of bits in a key used by a cryptographic algorithm. (recommended)

  • blank - No key bits are used.
  • 128
  • 196
  • 256
Cipher Mode

Choose the appropriate cipher mode from the dropdown. (recommended)

  • blank - No Cipher Mode is done
  • CBC - Each block of plaintext is XORed with the previous ciphertext block before being encrypted. This ensures that each ciphertext block depends on all previous plaintext blocks. CBC is more secure than ECB but cannot be parallelized for encryption.
  • ECB - Is the simplest block cipher mode. Each block of plaintext is directly encrypted into a block of ciphertext. However, it is not recommended for use in cryptographic protocols due to its lack of diffusion, which fails to hide data patterns.
Padding Mode

Choose the appropriate padding mode from the dropdown. (recommended)

  • blank - No Padding is done. 
  • PKCS7 - The padding string consists of a sequence of bytes, each of which is equal to the total number of padding bytes added.
Init Vector

Defaults as @1B2c3D4

Must be 8 characters in length and include upper and lower case, numeric and a special character (e.g. @ % & * # - _ $)