Quickstart

Before you begin

Create an API key in the Minlink console (Developer → API Keys).
Note your custom domain (if configured) for branded short links.
Install node-fetch@3 or use curl for quick tests.

1) Create a short link

curl -X POST https://cm.minlink.io/v1/api/links \
  -H "content-type: application/json" \
  -H "x-minlink-api-key: $MINLINK_API_KEY" \
  -d '{"originalUrl":"https://example.com","title":"Example","expiration":{"type":"never"}}'

Response includes shortUrl and the link _id. Share shortUrl or generate a QR from it.

2) Create a Smart Link

Smart Links pick destinations based on device/type (app download, multi-URL hubs, music/video, surveys).

curl -X POST https://cm.minlink.io/v1/api/smart-links \
  -H "content-type: application/json" \
  -H "x-minlink-api-key: $MINLINK_API_KEY" \
  -d '{"title":"Get the app","type":"appDownload","appstoreLink":"https://apps.apple.com/app/123","playstoreLink":"https://play.google.com/store/apps/details?id=com.example"}'

Copy the returned slug to route users via /smart-links/:slug.

3) Generate a QR code

curl -X POST https://cm.minlink.io/v1/api/qr-codes \
  -H "content-type: application/json" \
  -H "x-minlink-api-key: $MINLINK_API_KEY" \
  -d '{"title":"Docs QR","type":"url","content":{"url":"https://example.com/docs"}}'

Download the image: GET /qr-codes/:id/image?format=png&size=1024.

4) Enable webhooks

In the console, create a webhook and copy the secret (whsec_...).
Point it to your endpoint; verify x-minlink-signature HMAC SHA256 on the raw body.
Listen for events like link.created, qr.scanned, smart-link.clicked, storage.file.uploaded.

5) Store assets (optional)

Use storage to host covers/images/videos reused by Smart Links or landings. Start an upload session, PUT parts to presigned URLs, then complete the session.