Skip to main content

Postman Collection

Postman is an API platform for building and using APIs. To make integration with ChottuLink simpler, we provide a Postman Collection with all the tools you'll need to test the components of your integration.

Use the ChottuLink REST API to manage and automate dynamic links for your organization. This API enables you to list, create, update, enable/disable, and analyze dynamic links programmatically — perfect for dashboard integrations, automation workflows, and link management systems.

With ChottuLink's REST API, you can:

  • Retrieve all active and disabled links in a paginated format
  • Create and customize new dynamic links
  • Enable or disable existing links
  • Update link metadata or destination URLs
  • Get analytics and performance metrics for your links

🚀 Get Started​

Follow the steps below to authenticate and begin using the ChottuLink REST API in Postman.

1. Set Up Your Collection Variables​

To get started, populate the collection variables. Navigate to the collection in your workspace and you'll see a tab titled Variables as shown below.

Copy your REST API integration key from the ChottuLink Dashboard (found under Dashboard > Keys) and set up the following variables:

Collection Variables
VariableDescriptionExample
baseUrlThe API base endpointhttps://api2.chottulink.com
API-KEYYour REST API integration key (found under Dashboard > Keys)c_api_xxxxxxxxxxxxxxxxxxxxxx
API Key Security

Keep your API key secure and never share it publicly. The API key has full access to your ChottuLink account and can be used to create, modify, and manage your dynamic links.

Setting Up Collection Variables​

  1. Open the Collection: Import the ChottuLink Postman Collection into your Postman workspace
  2. Navigate to Variables: Click on the collection name and select the Variables tab
  3. Set Variables:
    • Set baseUrl to https://api2.chottulink.com
    • Set API-KEY to your REST API integration key from the ChottuLink Dashboard
  4. Save: The variables will be automatically saved and used in all collection requests

2. Authentication​

All requests must include the following header:

API-KEY: {{API-KEY}}

The collection automatically includes this header in all requests using the {{API-KEY}} variable.

3. Test Your Connection​

In Postman:

  1. Set baseUrl and API-KEY in your collection variables
  2. Choose any endpoint (like /chotuCore/pa/v1/links/page) and click Send
  3. If authentication is successful, you'll receive a JSON response with your organization's links
Quick Test

Start with the "List Links" endpoint as it's a simple GET request that doesn't require any request body parameters.

🧰 Available Endpoints​

The ChottuLink Postman Collection includes the following API endpoints:

Links Endpoints
TitleMethodEndpointCategory
List linksGET{baseUrl}/chotuCore/pa/v1/links/pageLinks
Get link InformationPOST{baseUrl}/chotuCore/pa/v1/links/infoLinks
Create linkPOST{baseUrl}/chotuCore/pa/v1/create-linkLinks
Update linkPATCH{baseUrl}/chotuCore/pa/v1/update-link/{linkId}Links
Enable/Disable a linkPATCH{baseUrl}/chotuCore/pa/v1/links/change-status/{linkId}Links
Analytics Endpoints
TitleMethodEndpointCategory
Get analyticsGET{baseUrl}/chotuCore/pa/v1/analyticsAnalytics

All endpoints use the {{baseUrl}} variable, which is automatically replaced with https://api2.chottulink.com when you send requests.

Importing the Collection​

Download and Import​

  1. Download the Collection: Download ChottuLink Postman Collection
  2. Open Postman: Launch Postman application
  3. Import: Click Import in the top left corner
  4. Select File: Choose the downloaded chottulink-postman-collection-v1.json file
  5. Import: Click Import to add the collection to your workspace

The collection will appear in your Postman workspace with all endpoints pre-configured and ready to use.

Using Variables in Requests​

All requests in the collection use variables for easy configuration:

  • Base URL: {{baseUrl}} - Automatically set to https://api2.chottulink.com
  • API Key: {{API-KEY}} - Your REST API integration key

The API key is automatically included in the API-KEY header for each request:

API-KEY: {{API-KEY}}

Environment Variables (Optional)​

For advanced usage, you can create Postman Environments to manage different API keys for different environments (development, staging, production):

  1. Create Environment: Click the gear icon in the top right and select Add
  2. Add Variables: Add baseUrl and API-KEY variables with your values
  3. Select Environment: Choose your environment from the dropdown
  4. Update Collection: Modify collection variables to use environment variables

Troubleshooting​

Common Issues​

401 Unauthorized Error

  • Verify your API key is correctly set in the collection variables
  • Ensure the API key is your REST API integration key (starts with c_api_)
  • Check that the API-KEY header is present in the request
  • Verify the API key is active in the ChottuLink Dashboard

404 Not Found Error

  • Verify the endpoint URL is correct
  • Check that you're using the correct HTTP method (GET, POST, PATCH, etc.)
  • Ensure the {{baseUrl}} variable is set correctly

400 Bad Request Error

  • Review the request body parameters
  • Ensure all required fields are included
  • Validate the data types and formats match the API documentation
  • Check endpoint-specific documentation for parameter requirements

Getting Help​

If you encounter issues:

  1. Check Documentation: Review the specific endpoint documentation in the REST API section
  2. Verify API Key: Confirm your API key is active in the ChottuLink Dashboard
  3. Test Connection: Use the "List Links" endpoint to verify your setup
  4. Contact Support: Reach out to our support team for assistance

Best Practices​

Collection Management Tips:
  • Keep API Keys Secure: Never commit Postman collections with real API keys to version control
  • Use Environments: Set up separate environments for different stages (dev, staging, prod)
  • Version Control: Export and version control your collection without sensitive data
  • Documentation: Add descriptions to requests and examples in the collection
  • Testing: Use Postman's test scripts to validate responses automatically
  • Variable Management: Always use variables for base URLs and API keys to make switching environments easier

Next Steps​

After setting up the Postman collection:

  1. Explore Endpoints: Try out different API endpoints to understand their functionality
  2. Read Documentation: Review the detailed API documentation for each endpoint:
  3. Integrate: Use the collection as a reference when implementing API calls in your application
  4. Automate: Set up Postman tests and monitors for continuous API validation

For detailed information about each endpoint, refer to the REST API documentation.