Postman Collection Setup

Get started quickly with the Docstron API using our ready-to-use Postman collection. All endpoints are pre-configured with examples and you can start testing immediately.

Download Collection

Download the Postman collection and environment files:

• Download Postman Collection - All API endpoints
• Download Environment - Environment variables

What’s Included

The Postman collection includes all Docstron API endpoints:

Applications

• Get All Applications
• Get Single Application

Templates

• Create Template
• Get Template
• Get All Templates
• Update Template
• Delete Template

Documents

• Generate Document (with template)
• Get Document
• Get All Document
• Update Document
• Delete Document
• Download Document

Usages

• Get Usage

Setting Up Postman

---

Step 1: Install Postman

If you don’t have Postman installed:

1. Visit postman.com/downloads
2. Download and install Postman for your operating system
3. Create a free Postman account (optional but recommended)

Step 2: Import Collection

1. Open Postman
2. Click the “Import” button in the top-left corner
3. Click “Choose Files” or drag and drop the Docstron-API-Collection.json file
4. Click “Import” to add the collection to your workspace

Alternative method:

• Click “Import” → “Link” tab
• Paste the collection URL (if provided)
• Click “Continue” → “Import”

Step 3: Import Environment

1. Click the “Import” button again
2. Select the Docstron-Environment.json file
3. Click “Import”
4. The environment will appear in the top-right environment dropdown

Step 4: Configure Environment Variables

1. Click the environment dropdown in the top-right corner
2. Select “Docstron Environment”
3. Click the eye icon (👁️) next to the environment name
4. Click “Edit” to update variables

Required variables to update:

Variable	Description	Example
BASE_URL	API base URL	https://api.docstron.com/v1
API_KEY	Your API key	dstr_g9miFIPt67EGiW7tj...

To get your API key:

1. Log in to docstron.com
2. Go to API Keys
3. Generate a new API key if you don’t have one
4. Copy the key and paste it into the API_KEY variable

Step 5: Save Environment

1. After updating all variables, click “Save”
2. Ensure the environment is selected in the top-right dropdown

Using the Collection

---

Making Your First Request

1. In the left sidebar, expand the “Docstron API” collection
2. Navigate to “Applications” → “Get All Applications”
3. Click on the request to open it
4. Click the blue “Send” button
5. View the response in the bottom panel

Understanding Requests

Each request in the collection includes:

• Pre-configured URL - Uses {{BASE_URL}} variable
• Authentication - Automatically includes {{API_KEY}}
• Request Body - Example data for POST/PATCH requests
• Example Responses - Sample successful responses

Environment Variables Explained

---

Base Variables

These variables are used across all requests:

URL = https://api.docstron.com/v1
API_KEY = YOUR_API_KEY_HERE

Path Parameters

When you see a colon (:) in the URL path, Postman treats it as a path parameter:

{{URL}}/applications/:application_id

Path parameters appear in the Params tab below the URL bar. You can set their values in two ways:

Option 1: Directly in Params tab

• The :application_id will appear as an editable field
• Enter the value directly (e.g., app_123456)

Option 2: Using environment variables

• In the Params tab, use {{application_id}} as the value
• Set application_id in your environment variables

Using Variables in Requests

Variables are referenced using colon :application_id

In URL with path parameters:

{{BASE_URL}}/applications/:application_id

Then in Params tab: application_id = app-58756d65..

In Headers:

Authorization: Bearer {{API_KEY}}

Testing Workflow

Follow this workflow to test the complete API:

1. Setup (One-time)

✓ Import collection
✓ Import environment
✓ Add your API key
✓ Create an application (via dashboard)
✓ Copy the application_id

2. Template Creation

1. Create Template → Save template_id
2. Get Template → Verify template details
3. Update Template (optional) → Test modifications

3. Document Generation

1. Generate Document → Save document_id
2. Get Document → Verify document details
3. Update Document (optional) → Modify attributes
4. Delete Document (optional) → Clean up

4. Cleanup (Optional)

1. Delete Template → Remove test template

Tips and Tricks

---

Quick Testing

• Use Collection Runner - Run all requests sequentially
• Duplicate Requests - Test different scenarios
• Save Responses - Use examples for documentation

Debugging

• Console Tab - View variable values and logs
• Response Tab - Check status codes and response data
• Headers Tab - Verify authentication headers

Best Practices

✅ Use environments - Separate dev, staging, production
✅ Name requests clearly - Easy to find specific endpoints
✅ Add descriptions - Document what each request does
✅ Save examples - Different success and error responses
✅ Use tests - Automate variable updates

Common Issues

❌ “Unauthorized” error

• Check your API key in environment variables
• Ensure the environment is selected in the top-right
• Verify the API key is still valid at docstron.com/api-keys

❌ “Application not found” error

• Update the application_id in environment variables
• Ensure the application exists in your dashboard
• Check that the application is active

❌ Variables not working (showing {{variable_name}})

• Select the correct environment from the top-right dropdown
• Check variable names match exactly (case-sensitive)
• Save the environment after making changes

Need Help?

If you encounter issues with the Postman collection:

• 📧 Email: support@docstron.com
• 💬 Live Chat: Available in your dashboard
• 📚 Postman Docs: learning.postman.com
• 🐛 Report Issues: Let us know if you find any errors in the collection