API Documentation

Integrate MiniFyn's powerful link shortening capabilities into your application with our simple and robust API.

Welcome to the MiniFyn API! Our API is designed to be straightforward and easy to use. All endpoints are served over HTTPS. To get started, you'll need an API key.

Authentication

API Key

All API requests must be authenticated with an API key. You can generate and manage your API keys from your dashboard.

Your API key must be included in the Authorization header as a Bearer token.

Don't have a key yet? Generate one now.

Versioning

The current version of the API is v1. The API is stable, but any future breaking changes will be introduced under a new version number.

Endpoints

Shorten a URL

POST /api/shorten

Creates a new short link for the provided long URL.

Headers

Header	Description
`Authorization`	Required. Your API key as a Bearer token (e.g., `mk_yourkey...`).
`Content-Type`	Required. Must be `application/json`.

Body

Parameter	Type	Description
`url`	string	Required. The long URL you want to shorten.

Example Request

curl -X POST https://minifyn.com/api/shorten \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-long-url.com"}'

Success Response (200 OK)

{
  "message": "URL shortened successfully",
  "shortUrl": "https://mnfy.in/abcdef"
}

Error Response (4xx)

{
  "error": "Please enter a valid URL."
}

Rate Limiting

To ensure fair usage and protect the service from abuse, the API is subject to rate limiting. Your API key allows for up to 20 requests per day.

In addition to the daily quota, a time-based throttle is in place to prevent rapid-fire requests. You are limited to 1 request per second per API key.

If you exceed either of these limits, you will receive a 429 Too Many Requests HTTP status code.