Self Service

Requirements

Postman Desktop App
Lytx Account credentials for a 'Full Access Role'

Before You Begin

Download the Customer Collection.postman_collection.json and import to your workspace.
Keep this collection open in Postman.

Instructions

Navigate to My Accounts tab on your Lytx Account.
Select the API access tab.
Select Generate New Key Pair.
In pop-up window, choose an API Public Key Name; if left blank, the name will populate as "Public Key" and include the time and date generated.
Select Download Private Key.
The private key imports to the downloads folder on your local machine and Stored Public Keys updates to reflect the new key.
NOTE: The public key will be stored for you, but your private key is not stored. You are responsible for storing and retaining your private key; technical support cannot recover this for you.
Select Activate this key. Once completed, Public/Private key updates with the name of the public key that has been activated.
Open the file to generate the private key and copy the file string to Access Token.
Signature Verified appears immediately above where the string is copied. This confirms that the private key and public key match, and the private key is owned by the public key.
Once this is completed, select Generate Token and the string that appears below is the short-lived token. The expiration date matches the same expiration date as the public key.
Copy the generated long lead token string.
Navigate to Postman.
In the Customer Collection.postman_collection.json, select file "User Registration".
Select GET – short lived token. GET {{urls.lytx-auth-token}}
Paste the long lead token string into the json.collection using the long lead token generated with Access token, and it will generate the short lead token.
Select "Send" to complete your request. This generates the identity token.
Navigate to Lytx Account. Copy and paste the identity token back into Access Token in the Lytx account.
Your request is verified and the authentication process is complete.

Guidelines

You are responsible for keeping track of your private key. If you lose your private key, you must complete the authentication process again.
Key pairs and tokens generated are valid for 6 months. You must complete the authentication process again upon the 6-month expiration.
Review the Terms of Use on the API Access tab in MyAdmin.