This guide will help you get up and running making your first Rixon Tokenization API call in just a few minutes.
This guide assumes you are a Rixon customer with admin access to your portal.
1. Generate your credentials
Before starting the process of data protection, you need to determine the type of data that requires protection. After that, you should define the data format and access privileges. To protect each type of data, you need to create a token definition that provides instructions to the Rixon platform on how to handle that specific data.
Setting Up API Keys
Navigate
From the sidenav in the portal, go to Account→Configurations→API Keys.
Service API Key Creation
In order to securely communicate with Rixon’s tokenization & data
protection API’s you will need to create a Service API key. Your account may already have an autogenerated API key created. Your API key(s)
should be stored securely and not shared since these keys are used to
authenticate to Rixon’s data protection functionality.
In order to use Rixon to secure your sensitive data, we need to prepare
Rixon to accept and protect your data. In order to configure Rixon you will
need a portal user with at least the "AccountAdmin" role
assigned or higher. This role will allow you to navigate
to Account→Configurations→API Keys.
An autogenerated API key may already exist. You are safe to use this autogenerated API Key. If you'd like to create a new Key yourself, locate the section labeled “Add an API Key.” Enter a name for the key in the title
field, and enter an expiration date. API Keys are not usable after they
expire and should be rotated frequently. Click “Issue New API Key” and your key will appear above under
the section labeled “Your Existing API Keys.”
Creating Token Definitions
Navigate
From the sidenav in the portal go to Account→Configurations→Token Definitions.
In the header of the token table, click “Create New” to
access the token creation wizard.
Token Definition Creation
The token creation wizard will walk you through steps to create your token
definition(s). You can accept the defaults or read the descriptions of each
option to customize how your data is handled. Make sure to repeat the
process of creating a token definition for each type of data you wish to
protect.
Configuring Security Policies
Navigate
From the sidenav in the portal go to Account→Configurations→Security Policies.
Security Policy Configuration
Security policies defined in Rixon will define the access controls that will be enforced on API requests for tokenization.
Locate the “Security Policy Table” and click the “Create New” button. Read the description of each option
and fill out the required fields. Customize each option as necessary or
accept the defaults. Make sure under access controls you give your security
policy the appropriate API operation permissions for your token definition.
2. Make your first API Call
With your API Key and Security Policy, you can now make an CreateSession API call. For this example, we'll hit the CreateSession endpoint which authenticates and authorizes, yielding a Session Token.
Session Tokens are short-lived. If you receive a 401 or 403, your token has likely expired — call CreateSession again. Do not cache Session Tokens indefinitely.
Below is an example. Where <YOUR_ACCOUNT_DOMAIN> is usually your accountname.app.rixontechnology.com. This can be found in your "Account Settings" in the portal.
curl
curl -X 'POST' \
'https://<YOUR_ACCOUNT_DOMAIN>/api/services/evtservice/createsession' \
-H 'Content-Type: application/json' \
-d '{
"apiKey": "<YOUR_API_KEY>",
"policy": "<THE_POLICY_NAME>",
"policyPassword": "<THE_POLICY_PASSWORD>"
}'
With the Session Token, you can now make a Tokenization API call. For this example, we'll hit the Tokenize endpoint which simply tokenizes a single value with the tokenization engine parameters defined in the Token Definition.
curl
curl -X 'POST' \
'https://<YOUR_ACCOUNT_DOMAIN>/api/services/evtservice/tokenize' \
-H 'Content-Type: application/json' \
-d '{
"sessionToken": "<THE_SESSION_TOKEN_FROM_PREVIOUS_REQUEST>",
"tokenName": "<THE_TOKENDEF_NAME>",
"value": "MySensitiveValue"
}'
Next steps
Congratulations, you've protected your data with tokenization! You're ready to dive deeper.
Reading through the rest of the guides will familiarize you with important Rixon API conventions and implementation concerns. The API references will give you a better understanding of what functionality is included in each
API and whether they will meet the needs of your use case. If you need help, see our support page. Happy developing!