Getting Started
The ADARA Privacy Token Server SDK allows you to tokenize Personally Identifiable Information (PII) within an isolated environment. The ADARA Privacy Tokens produced using this SDK follow a set of simple standards that allow you interact with other token producers to participate in meaningful data exchanges without revealing sensitive information about individual users.
ADARA wrote this SDK to offer out-of-the-box support for engagement with the ADARA Privacy Token API, but does not require this. Data partners can use the ADARA Privacy Token Server SDK without using the ADARA Privacy Token API.
Any tokenization data generated within the ADARA Privacy Token Server SDK is only transmitted to ADARA explicitly as described below. |
Download and Install
Download and install the ADARA Privacy Token Server SDK in Python.
Use pip as the package manager, available at PyPi.org at https://pypi.org/project/adara-privacy/.
(venv) % pip install adara-privacy
ADARA strongly recommends installing the ADARA Privacy Token Server SDK in a virtual environment. |
Languages / Libraries
ADARA's Code Quickstart provides multiple code examples, each in multiple languages viewable from the tabs of the code windows, as shown in the following example.
from adara_privacy import Identity, Identifiermy_identity = Identity( // pass the identifier type as an arg (placement doesn't matter) Identifier('email', 'someone.special@somedomain.com'), // or use a named argument Identifier(state_id = "D1234567"), )Setup Local Configuration
Configure the ADARA Privacy Token Server SDK using a single JSON configuration file with the following format:
xxxxxxxxxx{ "client_id": "<optional: your client ID>", "client_secret": "<optional: your client secret>", "auth_uri": "https://auth.adara.com/oauth/token", "privacy": { "private_salt" : "<!!REQUIRED!!: your PRIVATE salt value>", "common_salts" : { "adara" : "7f0587e5843dff04240624af5f215fe57ba9d5841ae25c5a22b0d95900ceb3ed", "my_consortium" : "34ef58c071c6c125c06103bb8bd1ce239afd4046711676a8d999df0c6a0c0820", "my_other_consortium" : "3362e7e25a9b2616d954d71bc9fcac87fb6939b85f4cf04e8d926d0e995723bf" }, "audience_uri": "https://api.adara.com", "pipeline_id": "<optional: your pipeline ID>" }}We discuss the values from the above configuration file in more detail in and Tokenization and Tokens. In the example above, the common salts for my_consortium and my_other_consortium are provided for illustrative purposes to represent that any consortiums of interest can be added by provided salt values in the "common_salts" node. There will be one token produced per identifier, per common salt, although this behavior can be overridden for specific identifiers at call time.
Set up your configuration file locally and point the environment variable ADARA_SDK_CREDENTIALS to your file location: Start by simply copying the JSON blob above and defining the values later.
% export ADARA_SDK_CREDENTIALS=<path to your config>/my_config.txt
The file path, name and extension are unimportant as long as they point to a readable file location in your local environment. |
Version History
| version | release details |
|---|---|
| 0.1 | initial release, Python-only |
Contact ADARA
A member from tech-consultants@adara.com will help guide you through the onboarding process and provide recommendations to make the effort as frictionless as possible. The online documentation contains sample code and and ADARA's Technical Consultant will provide templates if necessary.
For more information, contact an ADARA Customer Success Representative directly or email support@adara.com.