Get Started

What is DyLy?

DyLy is a comprehensive link generation and management service specifically designed for developers who need powerful, flexible, and secure link solutions.

With DyLy, developers can eliminate the hassles associated with link management and focus on growing their core business. Whether you need simple URL shortening, dynamic deep links for mobile apps, or secure JWT-based authentication links, DyLy provides a unified platform that handles all your link management needs with enterprise-grade reliability and security.

Key Benefits

  • Developer-First Design: RESTful APIs with comprehensive documentation make integration straightforward
  • Multiple Link Types: Support for URL redirects, JSON responses, JWT tokens, and deep links
  • Security Built-In: Optional key protection, one-time use links, and JWT signing for tamper-proof data
  • Flexible Pricing: Start with a free plan and scale as your needs grow
  • No Vendor Lock-in: Simple API-based architecture means you're never locked into proprietary SDKs

How to Use the Documentation

This documentation is divided into three main sections:

  • Get Started: Step-by-step instructions to help you create a new link and understand the core features of DyLy.
  • Guides: Tutorials for specific use cases—choose what's most relevant to you.
  • API Reference: A detailed reference for every API feature.

Prerequisites

Before you can create your first link with DyLy, you'll need to complete a few quick setup steps. This process takes just a few minutes and sets up everything you need to start generating links.

Step 1: Sign In to Your Account

  1. Navigate to the DyLy portal
  2. Click the Sign In button at the top-right corner
  3. Choose your preferred authentication method:
    • Google Account: Sign in with your Google credentials
    • Apple ID: Use your Apple ID for authentication
    • GitHub Account: Authenticate using your GitHub account

First-time users: If this is your first time signing in, DyLy will automatically create a new account for you. No additional registration steps are required.

Security Note: DyLy uses industry-standard OIDC for authentication. Your credentials are never stored by DyLy - authentication is handled directly by your chosen provider.

Step 2: Create Your First Project

Projects in DyLy serve as containers for your links and provide isolated environments for different applications or use cases.

  1. After signing in, you'll be prompted to create your first project
  2. Provide a project name that helps you identify this project (e.g., "Marketing Campaign", "Mobile App Links")
  3. Choose a unique subdomain - this will be part of your default domain (e.g., myapp.dyly.dev)
  4. Select a plan:
    • Free Plan: Perfect for getting started, includes basic features with some limitations
    • Paid Plan: Unlocks advanced features like custom domains, longer expiration times, and protected links

Important Limits:

  • Each account can create up to 5 free projects
  • Free projects have feature limitations (see Pricing for details)
  • Consider upgrading to a paid plan if you need advanced features or higher limits

Best Practice: Create separate projects for different environments (development, staging, production) to keep your links organized and manageable.

Step 3: Generate API Credentials

API credentials are required to interact with DyLy's REST API and create links programmatically.

  1. Navigate to your project dashboard
  2. Click on API Clients in the left sidebar menu
  3. A primary and secondary client pair will be automatically generated

Understanding API Clients:

  • Client ID: A public identifier for your application (safe to include in client-side code)
  • Client Secret: A confidential key that must be kept secure (never expose in client-side code or public repositories)
  • Primary & Secondary: Two sets of credentials allow for zero-downtime secret rotation

Security Best Practices:

  • ⚠️ Never commit your Client Secret to version control
  • Store secrets in environment variables or secure secret management systems
  • Use the secondary client when rotating secrets to avoid service disruption
  • Rotate secrets regularly and immediately if you suspect they've been compromised
  • You can regenerate secrets at any time from the portal

Tip: When rotating secrets, generate a new secondary secret, update your application to use it, verify it works, then rotate the primary secret. This ensures continuous availability.

After signing in to the portal, you can start creating links. DyLy offers two methods for link creation, each suited to different use cases.

Method 1: From the Portal (Quick & Easy)

The portal provides a user-friendly interface for creating links quickly without writing code.

  1. Sign in to the portal site
  2. Navigate to your project dashboard
  3. Click on Create Link or Links in the sidebar
  4. Fill in the link details and click Create

Limitations:

  • Portal creation is currently limited to URL-type links only
  • For other link types (JSON, JWT, Deep Links), you must use the API

When to use the portal:

  • Quick testing and prototyping
  • Creating simple redirect links
  • One-off link creation
  • When you need a visual interface

For more information about different link types and their capabilities, see Link Types.

The REST API is the recommended approach for production use and provides access to all DyLy features.

Why use the API:

  • Full Feature Access: Create all link types (URL, JSON, JWT, Deep Links)
  • Automation: Integrate link creation into your application workflows
  • Programmatic Control: Generate links dynamically based on user actions
  • Batch Operations: Create multiple links efficiently
  • CI/CD Integration: Include link creation in your deployment pipelines

Quick API Example:

curl -X POST https://dyly-api.lilacwells.com/url/api/v1/links \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic YOUR_CREDENTIALS" \
  -d '{
    "type": "url",
    "projectId": "your-project-id",
    "destinationUrl": "https://example.com/very/long/url",
    "path": "short",
    "expiresIn": 86400
  }'

This creates a short link that redirects to your destination URL and expires after 24 hours.

For comprehensive API documentation, including authentication, request/response formats, and advanced features, see the Link API Reference.

Next Steps

Now that you understand the basics, you can:

  1. Explore Link Types: Learn about URL, JSON, JWT, and Deep Links and when to use each
  2. Discover Core Features: Understand custom domains, protected links, and expiration settings
  3. Follow Use Case Tutorials: Implement common patterns like Magic Links or Invitation Links
  4. Review the API Reference: Deep dive into the complete API documentation

Tip: Start with a simple URL redirect link to familiarize yourself with the platform, then gradually explore more advanced features as your needs grow.