Quick Start Guide

Get up and running with Relink.is in just a few minutes. This guide will walk you through creating your first smartlink and setting up API access.

Prerequisites

Account Required: You’ll need a Relink.is account to get started. Sign up here if you haven’t already.

Subscription Requirements for API Access

✅ Professional Plan: Full API access
✅ Enterprise Plan: Full API access
❌ Starter Plan: API access restricted
❌ Free Plan: No API access

Creating Your First Smartlink

Go to relink.is and sign in to your account
You’ll be taken to your dashboard where you can manage all your smartlinks

Create a New Smartlink

Click the “Create Smartlink” button
Choose your smartlink type:
- App: App store redirections
- Url: URL shortener
- Landing: Landing pages
- QRTag: QR code pages
- DigiCard: Digital business cards
- TxtBin: Text sharing

Configure Your Smartlink

Choose a URL: Enter a custom URL slug (e.g., my-app)
Set the Name: Give your smartlink a descriptive name
Configure Settings: Based on your chosen type, configure the specific settings
Add Open Graph: Set title, description, and image for social sharing

Test Your Smartlink

Click “Save” to create your smartlink
Use the preview feature to test how it works
Share your smartlink: https://relink.is/your-custom-url

Setting Up API Access

⚠️

Professional/Enterprise Required: API access is only available for paid subscription plans.

Check Your Subscription

Navigate to Account > Billing in your dashboard
Ensure you have a Professional or Enterprise plan
Upgrade if necessary

Create an API Key

Go to Account > API in your dashboard
Click “Create API Key”
Enter a descriptive name (e.g., “Production Integration”)
Click “Create”

🚫

Important: Copy your API key immediately! It won’t be shown again for security reasons.

Test Your API Key

Make a test request to verify your API key works:

cURL


# Create a new smartlink
curl -X POST https://relink.is/api/v1/smartlink \
  -H "Authorization: Bearer rlk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "smartlinkName": "Test Link",
    "smartlinkType": "Url"
  }'
 
# Get all your smartlinks
curl -X GET https://relink.is/api/v1/smartlink \
  -H "Authorization: Bearer rlk_your_api_key_here"

JavaScript


// Create a new smartlink
const response = await fetch('https://relink.is/api/v1/smartlink', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer rlk_your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    smartlinkName: 'Test Link',
    smartlinkType: 'Url'
  })
});
 
const newSmartlink = await response.json();
console.log('Created:', newSmartlink);
 
// Get all smartlinks
const getAllResponse = await fetch('https://relink.is/api/v1/smartlink', {
  method: 'GET', 
  headers: {
    'Authorization': 'Bearer rlk_your_api_key_here'
  }
});
 
const allSmartlinks = await getAllResponse.json();
console.log('All smartlinks:', allSmartlinks);

Python


import requests
 
# Create a new smartlink
response = requests.post(
    'https://relink.is/api/v1/smartlink',
    headers={
        'Authorization': 'Bearer rlk_your_api_key_here',
        'Content-Type': 'application/json'
    },
    json={
        'smartlinkName': 'Test Link',
        'smartlinkType': 'Url'
    }
)
 
print('Created:', response.json())
 
# Get all smartlinks
get_response = requests.get(
    'https://relink.is/api/v1/smartlink',
    headers={
        'Authorization': 'Bearer rlk_your_api_key_here'
    }
)
 
print('All smartlinks:', get_response.json())

Common Use Cases

Creating App Store Redirections

Create a smartlink that automatically redirects users to the appropriate app store:


// First create the smartlink
{
  "smartlinkName": "My Mobile App",
  "smartlinkType": "App"
}
 
// Then update it with app store configuration
{
  "smartlinkId": "clp123abc456def",
  "smartlinkConfig": { "type": "App" },
  "configuration": {
    "smartlinkName": "My Mobile App",
    "smartlinkUrl": "my-app",
    "appStoreLink": "https://apps.apple.com/app/myapp",
    "googlePlayLink": "https://play.google.com/store/apps/details?id=com.myapp",
    "fallBackLink": "https://mywebsite.com"
  }
}

Creating URL Shorteners

Create short, memorable links with optional password protection:


// First create the smartlink
{
  "smartlinkName": "Documentation",
  "smartlinkType": "Url"
}
 
// Then configure the URL shortener
{
  "smartlinkId": "clp456def789ghi",
  "smartlinkConfig": { "type": "Url" },
  "configuration": {
    "smartlinkName": "Documentation", 
    "smartlinkUrl": "docs"
  },
  "shortener": {
    "url": "https://my-very-long-documentation-url.com",
    "protected": false
  }
}

Building Landing Pages

Create custom landing pages with multiple action buttons:


// First create the smartlink
{
  "smartlinkName": "Product Launch",
  "smartlinkType": "Landing"
}
 
// Then configure the landing page
{
  "smartlinkId": "clp789xyz123abc",
  "smartlinkConfig": { "type": "Landing" },
  "configuration": {
    "smartlinkName": "Product Launch",
    "smartlinkUrl": "launch"
  },
  "landing": {
    "title": "Welcome to Our Product!",
    "description": "Get started today",
    "themeColor": "#3B82F6"
  },
  "landingButtons": [
    {
      "id": "signup",
      "title": "Get Started", 
      "link": "https://myapp.com/signup"
    }
  ]
}

Next Steps

Now that you’re set up, explore these areas:

Smartlink Types: Learn about all 6 smartlink types
API Reference: Complete API documentation
Examples: Real-world implementation examples
Best Practices: Error handling, input validation and more.

Troubleshooting

API Key Issues

Problem: Invalid API key format Solution: Ensure your API key starts with rlk_

Problem: API access is not available for Starter subscription Solution: Upgrade to Professional or Enterprise plan

Validation Errors

Problem: Smartlink URL already exists Solution: Choose a different URL slug - they must be unique

Problem: Configuration validation failed Solution: Check that all required fields are provided and within character limits

Need Help?

📧 Email: [email protected]
📚 Documentation: Complete guides in this documentation
🐛 Bug Reports: Include API request/response details

💡

Ready to dive deeper? Check out the API Overview for comprehensive API documentation.