Relink API Postman Collection

This comprehensive Postman collection contains all the API endpoints for testing and interacting with the Relink smartlink service. It includes examples for every endpoint, error scenarios, and pre-configured environment variables.

Collection Overview

The collection includes organized folders for:

• Authentication testing - Validate API keys and test authentication scenarios
• GET Smartlinks - Retrieve all smartlinks or specific smartlinks by ID
• POST - Create Smartlinks - Create new smartlinks with default or custom URLs
• PUT - Update Smartlinks - Complete examples for updating all smartlink types:
  • App smartlinks with store links and fallbacks
  • Landing pages with buttons and styling
  • URL shorteners (with and without password protection)
  • QR Tag pages with preset button styles
  • Digital business cards with contact information
  • Text bins for code snippets and content sharing
• DELETE Smartlinks - Soft delete functionality
• Analytics - Individual smartlink and summary analytics
• Error Testing - Common error scenarios and edge cases

Getting Started

1. Download the Collection

   • Download: Relink_API_Collection.postman_collection.json

2. Import into Postman

   • Open Postman
   • Click “Import” button
   • Drag and drop the downloaded JSON file
   • The collection will be imported with all requests organized in folders

3. Set up Environment Variables

   {
     "BASE_URL": "https://relink.is",
     "API_KEY": "rlk_your_api_key_here",
     "SMARTLINK_ID": "your_smartlink_id_here"
   }

Environment Variables

The collection uses three main variables that you need to configure:

Setting up variables:

1. Click the gear icon (⚙️) in the top right
2. Select “Manage Environments”
3. Create a new environment or edit existing
4. Add the three variables with your actual values

Collection Structure

1. Authentication

• Test API Key - Validates your API key is working correctly

2. GET Smartlinks

• Get All Smartlinks - Retrieves all active smartlinks for the authenticated user
• Get Specific Smartlink - Retrieves a specific smartlink by ID with all related data

3. POST - Create Smartlinks

• Create App Smartlink (Default) - Creates with auto-generated URL
• Create App Smartlink (Custom URL) - Creates with a custom 6-character URL

4. PUT - Update Smartlinks

App Configuration

Complete app store redirection setup with:

• iOS App Store, Google Play Store links
• Windows Store, Mac App Store (Professional+ only)
• iPad, Huawei AppGallery, Amazon Store links
• Fallback URL for unsupported platforms
• Open Graph metadata for social sharing
• Custom HTML injection for tracking

Landing Page

Dynamic landing pages with:

• Custom title, description, and branding
• Logo and theme color customization
• Multiple action buttons with custom icons
• List or Grid layout options
• Light/Dark theme support

URL Shortener

• Basic URL shortening functionality
• Password protection option for sensitive links
• Custom short URL slugs

QR Tag

QR-code optimized pages with:

• Restaurant, delivery, phone presets
• Custom button styling and positioning
• Mobile-optimized layouts

Digital Card

Professional business cards with:

• Contact information display
• Social media links (LinkedIn, email, phone, website)
• Company branding and background images
• Call-to-action customization

Text Bin

Code and text sharing with:

• Syntax highlighting support
• Title and description fields
• Large text content support (up to 2500 characters)

5. DELETE Smartlinks

• Delete Smartlink - Soft delete (sets status to ‘Deleted’)

6. Analytics

• Get Smartlink Analytics - Detailed metrics for a specific smartlink including:
  • Click and QR scan counts
  • Geographic breakdown (countries, cities)
  • Device and browser analytics
  • Time-based performance data
  • Traffic source analysis
• Get All Analytics Summary - Aggregated analytics across all smartlinks

7. Error Testing

Comprehensive error scenario testing:

• Invalid API Key - Tests 401 authentication errors
• Missing Authorization - Tests missing auth header scenarios
• Duplicate URL Creation - Tests 409 conflict errors
• Invalid JSON - Tests 400 malformed request errors

Features Included

Complete CRUD Operations

• ✅ Create smartlinks (POST)
• ✅ Read smartlinks (GET)
• ✅ Update smartlinks (PUT)
• ✅ Delete smartlinks (DELETE)

All Smartlink Types

• ✅ App Store redirections
• ✅ Landing pages with buttons
• ✅ URL shorteners
• ✅ QR Tag pages
• ✅ Digital business cards
• ✅ Text bins

Advanced Features

• ✅ Password-protected links
• ✅ Custom HTML injection
• ✅ Open Graph metadata
• ✅ Analytics tracking
• ✅ Comprehensive error handling
• ✅ Subscription-based feature restrictions

Analytics & Monitoring

• ✅ Individual smartlink analytics
• ✅ Summary analytics across all smartlinks
• ✅ Geographic and device breakdowns
• ✅ Performance metrics over time

Testing Workflow

1. Authentication Test

Start by running the “Test API Key” request to ensure your API key is valid.

2. Create Test Smartlinks

Use the POST requests to create different types of smartlinks for testing.

3. Retrieve and Update

Use GET requests to retrieve your smartlinks, then test PUT requests to update them with different configurations.

4. Analytics Testing

Once you have active smartlinks, test the analytics endpoints to see performance data.

5. Error Scenarios

Run the error testing requests to ensure your application handles failures gracefully.

6. Cleanup

Use the DELETE request to clean up test smartlinks when done.

Response Examples

All requests include example responses showing the complete data structure you can expect from each endpoint. This helps with:

• Understanding the response format
• Planning your application’s data handling
• Debugging integration issues
• Validating your request format

Best Practices for Testing

1. Start with Authentication - Always test your API key first
2. Use Environment Variables - Set up your API key and base URL in Postman environments
3. Test Error Cases - Run error scenarios to understand failure modes
4. Validate Responses - Check that all expected fields are present in responses
5. Test All Smartlink Types - Each type has different configuration options
6. Monitor Rate Limits - Be aware of your subscription’s API rate limits
7. Clean Up - Delete test smartlinks to avoid hitting subscription limits

Support

If you encounter issues with the Postman collection:

1. Verify your API key is valid using the validation endpoint
2. Check that your subscription plan supports API access
3. Ensure you’re using the correct base URL
4. Review the error response for specific guidance
5. Contact support with specific error messages and request details

The collection is regularly updated to reflect the latest API features and endpoints.