Setup the Tally Platform API via Postman
This documentation guides you through setting up and using the Tally Platform APIs via Postman. It provides step-by-step instructions for configuring your environment, authentication, and executing API requests.
Prerequisites
The Postman application must be installed on your device. If it's not installed, download from: Download Postman | Get Started for Free 
You will need the Tally API file, as well as the environment and user files provided by our team.
Setup Instructions
Import Files
- Open Postman and click Import in the top-left corner.
- Click on Select Files and navigate to the downloaded collection and environment files.
- Confirm import when prompted.
Environment Configuration
- After importing, locate the environment dropdown menu in the top-right corner and select your default environment.
- This environment contains predefined variables required for API execution.
Authentication
- Click on Tally Platform Services in the collections panel.
- Navigate to the Authorization tab and enter your Client ID and Client Secret. Reach out to our team if you have questions about authentication.
- Scroll to the bottom and click Get New Access Token.
- Wait a few seconds while the authentication token is generated. Click Use Token when prompted.
- Authentication is now complete, and you can begin using the APIs.
If the token expires, repeat the steps to generate a new token.
API Structure and Variables
Environment Variables
Key variables are preconfigured in the environment:
- Base URL
- AccountNumber
- Various required IDs
Variable Management
When first imported, environment variable values are blank by default. Variables are automatically populated as you execute API calls.
Examples:
- Running "Enroll Member" will populate the accountNumber variable.
- Running "Create Member Address" will populate the MemberAddressID variable.
You can also manually set values if needed.
API Organization
The API collection is organized into functional folders: for example, member-promotion contains:
- GET Get Member Promotions
- POST Register member for promotion
- GET Get Member Promotion By Member Promotion ID
You can also browse our API reference documentation here.
Use the APIs
- Expand the relevant folder in the collection.
- Select the API you wish to execute.
- Review any required parameters or body content.
- Click Send to execute the request.
- Review the response in the lower panel.