Mayy.my.id

Smart Link & QR Platform

OpenAPI 3.1.0v3.5.0Active Gateway

Mayy Link Platform API

High-performance, resilient API for creating shortened URLs, date-prefixed links, custom aliases, batch operations, QR code generation, UTM campaign tracking, Prometheus metrics, and real-time telemetry on mayy.my.id.

/api/openapi.json
Server:
API Key:
x-mayy-api-key
·
Core Shortening & Generation2
POST/api/create

Create a shortened URL (Universal compatibility)

Fast link creation with UTM tags, device targeting (iOS / Android), custom slugs, and rate limit guard.

Request Body (application/json)

Schema Preview:
{
  "url": "https://example.com/product/flash-sale",
  "aliasType": "custom_random",
  "customPrefix": "flash",
  "utm_source": "newsletter",
  "utm_campaign": "summer_sale",
  "tags": [
    "promo",
    "ecommerce"
  ]
}

Expected Responses

200Created successfully (Plaintext fallback)
201Created successfully (JSON)

Live "Try It Out" Console

Target: https://mayy.my.id/api/create

Client Code Snippets

curl -X POST "https://mayy.my.id/api/create" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/product/flash-sale", "aliasType": "custom_random", "customPrefix": "flash", "utm_source": "newsletter", "utm_campaign": "summer_sale", "tags": [ "promo", "ecommerce" ] }'
GET/api/create
Link Management (CRUD)5
GET/api/v1/links
POST/api/v1/links
GET/api/v1/links/{code}
PATCH/api/v1/links/{code}
DELETE/api/v1/links/{code}
Batch Provisioning1
POST/api/v1/links/batch
Dynamic QR Codes & Visuals2
GET/api/v1/links/{code}/qr
GET/api/qr
Slug Verification & Bulk Resolution2
GET/api/v1/slugs/check

Pre-flight slug availability & collision verification

Check if a custom slug is available or already claimed with alternatives.

Parameters(1)

NameInTypeRequiredDescription
slugquerystringRequiredDesired slug to check (e.g. flash-sale-2026)

Expected Responses

200Availability status, collision diagnosis, and alternative slug suggestions

Live "Try It Out" Console

Target: https://mayy.my.id/api/v1/slugs/check

Client Code Snippets

curl -X GET "https://mayy.my.id/api/v1/slugs/check?slug=flash-sale-2026"
POST/api/v1/links/expand
Security, Webhooks & Auth2
POST/api/v1/webhooks/test
GET/api/v1/keys/verify
Analytics & Prometheus Telemetry2
GET/api/v1/analytics/timeseries
GET/api/metrics