Setting Up Postman
Initial Steps
- Install Postman - Download from Postman’s official site
- Import the Collection - Fork the Transcrypts API collection using the “Run in Postman” button available in the documentation
- Configuration - After importing both the collection and environment variables, proceed to configure your API credentials
Configuring Postman
The collection utilizes Postman’s environment variables feature to streamline API requests.Configuration Steps
- Select the Development environment from the top-right corner
- Click the eye icon to access environment settings
- Enter your credentials from the Transcrypts Dashboard:
client_idaccess_key
- Save your changes to begin making API requests
Making Requests
The collection includes pre-configured scripts for both request setup and response handling to facilitate data flow between sequential calls.Recommended Workflow
-
Create an Order (VOIE Basic)
- Response includes a
shareURLfor completing the order
- Response includes a
-
Retrieve Order Details
- Uses the
orderIdvariable from the initial request
- Uses the
-
Fetch VOIE Report
- Automatically passes through
user_idandvoie_report_idvariables from previous responses
- Automatically passes through