API v2 Shortener

अपने ऐप से शॉर्ट लिंक बनाएँ और प्रबंधित करें। Base URL: https://api.s.id/v2। वर्तमान संस्करण 2.0.0 है, और पूरी विशिष्टता OpenAPI प्रारूप में उपलब्ध है।

इंटरैक्टिव संदर्भ

प्रमाणीकरण

API key sk_live_... या OAuth 2.0 access token को Authorization: Bearer हेडर में भेजें। API key Dashboard > Developer में बनाएँ; हर key केवल आपके चुने हुए scope इस्तेमाल कर सकती है।

दायरा	पहुँच
`links:read`	लिंक सूचीबद्ध और पढ़ें
`links:write`	लिंक बनाएँ और अपडेट करें (बनाना, संपादित करना, पुनर्स्थापित करना)
`links:archive`	लिंक संग्रहित करें
`links:analytics`	प्रति लिंक क्लिक आँकड़े और आजीवन संख्या पढ़ें

http

Authorization: Bearer sk_live_...

पूरी प्रमाणीकरण मार्गदर्शिका

लिंक बनाना

गंतव्य URL के साथ POST /links भेजें। custom_slug खाली होने पर slug अपने-आप बन जाएगा।

bash

curl -X POST https://api.s.id/v2/links \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"long_url": "https://example.com/long-url", "custom_slug": "[your-alias]"}'

फ़ील्ड	प्रकार	आवश्यक	विवरण
`long_url`	`string`	हाँ	गंतव्य URL
`title`	`string`	नहीं	लिंक शीर्षक
`custom_slug`	`string`	नहीं	कस्टम slug; खाली होने पर अपने-आप बनता है
`password`	`string`	नहीं	लिंक की रक्षा करने वाला पासवर्ड
`expired_at`	`integer`	नहीं	Unix timestamp (सेकंड) के रूप में समाप्ति समय
`domain_alias`	`string`	नहीं	s.id की जगह इस्तेमाल होने वाला कस्टम domain

उदाहरण प्रतिक्रिया:

json

{
  "data": {
    "id": 123,
    "short": "[your-alias]",
    "short_url": "https://s.id/[your-alias]",
    "long_url": "https://example.com/long-url",
    "microsite": false,
    "protected": false,
    "disposable": false,
    "adult": false
  },
  "message": "link_created"
}

एंडपॉइंट सूची

Links

GET/linksलिंक सूचीबद्ध करें

Returns a paginated list of the authenticated user's links.

बेस URL: https://api.s.id/v2 · दायरा: links:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`page`	query	`integer`	नहीं
`limit`	query	`integer`	नहीं
`search`	query	`string`	नहीं	Filter by short code or URL

रिस्पॉन्स

कोड	विवरण
`200`	List of links
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/linksलिंक बनाएँ

बेस URL: https://api.s.id/v2 · दायरा: links:write

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`long_url`	`string`	हाँ	The destination (long) URL
`title`	`string`	नहीं
`custom_slug`	`string`	नहीं	Custom short code; auto-generated when omitted
`password`	`string`	नहीं	Optional password to protect the link
`expired_at`	`integer`	नहीं	Optional expiry as a Unix timestamp (seconds)
`domain_alias`	`string`	नहीं	Custom domain to use instead of s.id

रिस्पॉन्स

कोड	विवरण
`200`	A single link
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/availableSlug की उपलब्धता जाँचें

Checks whether a custom slug is available before creating a link.

बेस URL: https://api.s.id/v2 · दायरा: links:read

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`short`	`string`	हाँ
`domain_alias`	`string`	नहीं	Custom domain, if any

रिस्पॉन्स

कोड	विवरण
`200`	Slug is available
`401`	Missing or invalid API key
`422`	Slug is taken or invalid

GET/links/{short}लिंक पाएँ

बेस URL: https://api.s.id/v2 · दायरा: links:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the link

रिस्पॉन्स

कोड	विवरण
`200`	A single link
`401`	Missing or invalid API key
`404`	Resource not found

PUT/links/{short}लिंक अपडेट करें

Updates a link. All fields are optional; omitted fields are left unchanged. - password: set a non-empty string to protect, empty string "" to remove protection. - custom_slug: rename the short code (subject to quota). - archive_at: schedule auto-archive on a date (YYYY-MM-DD). - domain_alias: change the custom domain (must be owned by the user).

बेस URL: https://api.s.id/v2 · दायरा: links:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the link

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`long_url`	`string`	नहीं	New destination URL
`title`	`string`	नहीं
`custom_slug`	`string`	नहीं	Rename the short code (subject to plan quota)
`password`	`string`	नहीं	Set a password (`""` removes existing protection)
`disposable`	`boolean`	नहीं	Mark link as disposable (expires after first click)
`adult`	`boolean`	नहीं	Flag link as adult content
`archive_at`	`string`	नहीं	Schedule auto-archive on this date (YYYY-MM-DD)
`domain_alias`	`string`	नहीं	Change the custom domain (must be owned by the user)

रिस्पॉन्स

कोड	विवरण
`200`	A single link
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

DELETE/links/{short}लिंक संग्रहित करें

Archives (soft-deletes) a link. The short code stops resolving. Use POST /links/{short}/unarchive to restore.

बेस URL: https://api.s.id/v2 · दायरा: links:archive

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the link

रिस्पॉन्स

कोड	विवरण
`200`	Link archived
`401`	Missing or invalid API key
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/{short}/unarchiveसंग्रहित लिंक पुनर्स्थापित करें

Restores a previously archived link, making its short code resolve again.

बेस URL: https://api.s.id/v2 · दायरा: links:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the archived link

रिस्पॉन्स

कोड	विवरण
`200`	Link restored
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/statsलिंक क्लिक टाइमलाइन

Returns a date-bucketed click-count timeline for the link.

बेस URL: https://api.s.id/v2 · दायरा: links:analytics

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक
`short`	path	`string`	हाँ
`start`	query	`string`	नहीं
`end`	query	`string`	नहीं

रिस्पॉन्स

कोड	विवरण
`200`	Click timeline
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/stats/lifetimeकुल आजीवन क्लिक

Returns the all-time total click count for a single link.

बेस URL: https://api.s.id/v2 · दायरा: links:analytics

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Lifetime click count
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/bulkएक साथ कई लिंक बनाएँ

Create up to 100 short links in a single request. Requires a subscription plan with bulk shortening enabled. Each item reports individual success/failure — the overall request always returns 200 even if some items fail.

बेस URL: https://api.s.id/v2 · दायरा: links:write

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`links`	`object[]`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Bulk result — individual items may have success=false
`401`	Missing or invalid API key
`402`	Plan upgrade required (bulk shortening not in plan)
`403`	API key lacks the required scope

User

GET/userप्रमाणित उपयोगकर्ता पाएँ

बेस URL: https://api.s.id/v2 · दायरा: user:read

रिस्पॉन्स

कोड	विवरण
`200`	User profile
`401`	Missing or invalid API key
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/quotaअकाउंट कोटा पाएँ

Returns the authenticated user's current plan limits and usage counters.

बेस URL: https://api.s.id/v2 · दायरा: user:read

रिस्पॉन्स

कोड	विवरण
`200`	Account quota
`401`	Missing or invalid API key
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

QR

GET/qrग्लोबल QR सेटिंग पाएँ

Returns the account-level (global) QR code settings applied to QR codes by default.

बेस URL: https://api.s.id/v2 · दायरा: qr:read

रिस्पॉन्स

कोड	विवरण
`200`	Global QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/qrग्लोबल QR सेटिंग कस्टमाइज़ करें

Updates the account-level (global) QR code settings. All fields are optional; omitted fields are left unchanged.

बेस URL: https://api.s.id/v2 · दायरा: qr:write

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`logo`	`string`	नहीं	URL of the logo image embedded in the QR code
`color`	`string`	नहीं	Foreground color as a hex value, e.g. #1a56db

रिस्पॉन्स

कोड	विवरण
`200`	Updated global QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/qrलिंक की QR सेटिंग पाएँ

Returns the QR code settings for a single link.

बेस URL: https://api.s.id/v2 · दायरा: qr:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the link

रिस्पॉन्स

कोड	विवरण
`200`	Link QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/links/{short}/qrलिंक की QR सेटिंग कस्टमाइज़ करें

Updates the QR code settings for a single link. All fields are optional; omitted fields are left unchanged.

बेस URL: https://api.s.id/v2 · दायरा: qr:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`short`	path	`string`	हाँ	The short code of the link

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`logo`	`string`	नहीं	URL of the logo image embedded in the QR code
`color`	`string`	नहीं	Foreground color as a hex value, e.g. #1a56db

रिस्पॉन्स

कोड	विवरण
`200`	Updated link QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

Microsites

GET/micrositesMicrosite सूचीबद्ध करें

Returns a paginated list of microsites owned by the authenticated user.

बेस URL: https://api.s.id/v2 · दायरा: microsites:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`limit`	query	`integer`	नहीं
`after`	query	`string`	नहीं	Cursor for the next page (opaque string from previous response)

रिस्पॉन्स

कोड	विवरण
`200`	List of microsites
`401`	Missing or invalid API key
`403`	API key lacks the required scope

POST/micrositesMicrosite बनाएँ

बेस URL: https://api.s.id/v2 · दायरा: microsites:write

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`slug`	`string`	हाँ	URL-safe identifier (alphanumeric + hyphens/underscores)
`title`	`string`	हाँ
`kind`	`string`	हाँ	Microsite category (e.g. `personal_branding`, `brand`, `other`)
`theme`	`string`	नहीं	Theme slug (optional, defaults to the platform default)

रिस्पॉन्स

कोड	विवरण
`200`	Microsite created
`400`	Validation error (slug already taken, quota exceeded, etc.)
`401`	Missing or invalid API key
`403`	API key lacks the required scope

GET/microsites/{slug}Microsite पाएँ

बेस URL: https://api.s.id/v2 · दायरा: microsites:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Microsite detail
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

PUT/microsites/{slug}Microsite अपडेट करें

Patches title, description, and/or visibility. All fields are optional.

बेस URL: https://api.s.id/v2 · दायरा: microsites:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`title`	`string`	नहीं
`description`	`string`	नहीं
`hide`	`boolean`	नहीं	Set `true` to hide the microsite from public (requires plan that supports visibility toggle)

रिस्पॉन्स

कोड	विवरण
`200`	Updated microsite
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

DELETE/microsites/{slug}Microsite हटाएँ

बेस URL: https://api.s.id/v2 · दायरा: microsites:delete

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Microsite deleted
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

POST/microsites/availableMicrosite slug की उपलब्धता जाँचें

Checks whether a microsite slug is available before creating a microsite.

बेस URL: https://api.s.id/v2 · दायरा: microsites:read

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`slug`	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Slug availability result
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/microsites/{slug}/componentsMicrosite कंपोनेंट सूचीबद्ध करें

Returns the components belonging to a microsite, in display order.

बेस URL: https://api.s.id/v2 · दायरा: microsites:read

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ	The slug of the microsite

रिस्पॉन्स

कोड	विवरण
`200`	List of microsite components
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/microsites/{slug}/componentsMicrosite कंपोनेंट जोड़ें

Adds a new component to a microsite. The body is { kind, data, tag? }. The shape of the data object depends on kind. Unknown fields are ignored, validation is per-kind, and invalid input returns 422. All color fields are hex strings (e.g. #1a56db). **Kinds:** PROFILE, LINK, HORIZONTAL_LINK, TEXT, IMAGE, MEDIA, DIVIDER, COUNTDOWN, MAPS, IMAGE_SLIDE, CV, AUTOPLAY_MUSIC, CONTACT, CALENDAR, SHOP_LISTING, SHOP_ITEM, SHOP_LEADERBOARD. **Rules:** - PROFILE, CV and AUTOPLAY_MUSIC are unique — at most one per microsite. - IMAGE_SLIDE requires a plan with the Image Slide feature. - On create the password is always stored empty — set or change it via update (PUT). - Image fields (image, imageBackground, slide image) must be a local asset path, not a remote URL — they must match [/.a-zA-Z0-9_-]+.(jpg|jpeg|png|svg|webp|gif|bmp); any value containing a scheme (https://), //, or .. is rejected. **Shared field groups** (a kind that lists a group accepts all of its fields inside data): - **Button styling** (LINK, CONTACT, CALENDAR): icon (string, max 255), textFont (string, max 100), textPosition (string, max 100), buttonEffect (string, max 100), buttonColor (hex, max 20), buttonBorderColor (hex, max 20), buttonIconBackground (hex, max 20), buttonShadowColor (hex, max 20). - **Spoiler reveal** (TEXT, IMAGE, MEDIA, MAPS, IMAGE_SLIDE, SHOP_LEADERBOARD): isSpoiler (bool), spoilerButtonText (string, max 140), spoilerButtonTextPosition (string, max 100), spoilerButtonIcon (string), spoilerButtonColor (hex, max 20), spoilerButtonFont (string, max 100), spoilerBackground (string, max 100), spoilerBackgroundOpacity (string, max 100), spoilerButtonBorderColor (hex, max 20), spoilerButtonIconBackground (hex, max 20), spoilerButtonShadowColor (hex, max 20). - **Password protection** (LINK, TEXT, IMAGE, MEDIA, MAPS, IMAGE_SLIDE, CONTACT, CV, SHOP_LEADERBOARD): passwordActive (bool), password (string, max 255 — set via update only), passwordMessage (string, max 255).

बेस URL: https://api.s.id/v2 · दायरा: microsites:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ	The slug of the microsite

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`kind`	`PROFILE \| LINK \| HORIZONTAL_LINK \| TEXT \| IMAGE \| MEDIA \| DIVIDER \| COUNTDOWN \| MAPS \| IMAGE_SLIDE \| CV \| AUTOPLAY_MUSIC \| CONTACT \| CALENDAR \| SHOP_LISTING \| SHOP_ITEM \| SHOP_LEADERBOARD`	हाँ	Component kind. The shape of `data` depends on this value.
`data`	`object`	हाँ	Kind-specific component data. Its shape depends on `kind`. See the operation description and examples below.
`tag`	`string`	नहीं	Optional grouping tag

रिस्पॉन्स

कोड	विवरण
`200`	Component created
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/microsites/{slug}/components/{componentId}Microsite कंपोनेंट अपडेट करें

Updates a single microsite component.

बेस URL: https://api.s.id/v2 · दायरा: microsites:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ	The slug of the microsite
`componentId`	path	`string`	हाँ	The component ID

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`active`	`boolean`	हाँ	Whether the component is shown
`kind`	`string`	हाँ	Component kind (e.g. `LINK`, `PROFILE`, `TEXT`)
`data`	`object`	हाँ	Kind-specific component data

रिस्पॉन्स

कोड	विवरण
`200`	Component updated
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

DELETE/microsites/{slug}/components/{componentId}Microsite कंपोनेंट हटाएँ

Deletes a single microsite component.

बेस URL: https://api.s.id/v2 · दायरा: microsites:delete

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ	The slug of the microsite
`componentId`	path	`string`	हाँ	The component ID

रिस्पॉन्स

कोड	विवरण
`200`	Component deleted
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/microsites/{slug}/components/orderMicrosite कंपोनेंट का क्रम बदलें

Reorders a microsite's components according to the provided list of component IDs.

बेस URL: https://api.s.id/v2 · दायरा: microsites:write

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`slug`	path	`string`	हाँ	The slug of the microsite

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`orders`	`string[]`	हाँ	Component IDs in the desired display order

रिस्पॉन्स

कोड	विवरण
`200`	Components reordered
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

OAuth 2.0

GET/oauth/authorizeGet consent screen data

A plain browser navigation here (no Accept: application/json) 302-redirects to the dash.s.id consent UI, preserving the query string. With Accept: application/json, returns application name, logo, and requested scopes for the consent UI to render.

बेस URL: https://api.s.id

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`client_id`	query	`string`	हाँ
`redirect_uri`	query	`string`	हाँ
`response_type`	query	`code`	हाँ
`scope`	query	`string`	नहीं
`state`	query	`string`	नहीं	Recommended. Opaque value for CSRF protection. Returned unchanged in the redirect.

रिस्पॉन्स

कोड	विवरण
`200`	Consent screen data
`400`	Bad request

POST/oauth/tokenExchange code or refresh token

बेस URL: https://api.s.id

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक
`grant_type`	`authorization_code \| refresh_token`	नहीं
`code`	`string`	नहीं
`redirect_uri`	`string`	नहीं
`client_id`	`string`	नहीं
`client_secret`	`string`	नहीं
`refresh_token`	`string`	नहीं

रिस्पॉन्स

कोड	विवरण
`200`	Token response
`400`	Invalid grant, unsupported_grant_type, or invalid_client
`401`	Invalid client credentials

POST/oauth/revokeRevoke a token

Revokes an access or refresh token. Always returns 200 OK regardless of whether the token was valid (RFC 7009).

बेस URL: https://api.s.id

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक	विवरण
`token`	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Token revoked

POST/oauth/introspectIntrospect a token

Reports whether a token is currently active and, if so, which scopes and client it belongs to (RFC 7662). Client-credential protected: client_id/client_secret identify the caller, not the token owner. Always returns 200 — including for an unknown, expired, or revoked token ({"active": false}) — to avoid leaking token validity to unauthenticated probing.

बेस URL: https://api.s.id

रिक्वेस्ट बॉडी

फ़ील्ड	प्रकार	आवश्यक
`token`	`string`	हाँ
`client_id`	`string`	हाँ
`client_secret`	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	Introspection result
`400`	Missing token/client_id, or invalid client credentials

GET/oauth/userinfoGet authorized user profile

Returns the profile of the user who authorized the OAuth app. Requires Authorization: Bearer <access_token> (the OAuth access token, not an sk_live_ key).

बेस URL: https://api.s.id · दायरा: user:read

रिस्पॉन्स

कोड	विवरण
`200`	User profile
`401`	Unauthorized

GET/.well-known/oauth-authorization-serverOAuth 2.0 Authorization Server Metadata

RFC 8414 discovery document advertising every OAuth endpoint URL, supported scopes, and PKCE methods, so standards-compliant client libraries can configure themselves instead of hard-coding s.id's URLs.

बेस URL: https://api.s.id

रिस्पॉन्स

कोड	विवरण
`200`	Authorization server metadata

GET/api/user/oauth/appsList apps authorized by the current user

Returns all OAuth clients that have active tokens for the authenticated user. Auth: user session cookie (not API key).

बेस URL: https://api.s.id

रिस्पॉन्स

कोड	विवरण
`200`	List of connected apps
`401`	Unauthorized

DELETE/api/user/oauth/apps/{clientId}Revoke all tokens for an app

Revokes all active tokens granted by the current user to the specified OAuth client.

बेस URL: https://api.s.id

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`clientId`	path	`string`	हाँ

रिस्पॉन्स

कोड	विवरण
`200`	App access revoked
`401`	Unauthorized
`404`	App not found

Analytics

GET/statsअकाउंट-स्तरीय क्लिक एनालिटिक्स

Returns a timeline of clicks plus breakdowns by top links, referers, locations, devices, and browsers for the authenticated account. Date range is gated by subscription plan.

बेस URL: https://api.s.id/v2 · दायरा: links:analytics

पैरामीटर

फ़ील्ड	स्थान	प्रकार	आवश्यक	विवरण
`start`	query	`string`	नहीं	Start date (YYYY-MM-DD). Defaults to 30 days ago.
`end`	query	`string`	नहीं	End date (YYYY-MM-DD). Defaults to today.
`additional`	query	`boolean`	नहीं	Include referer, location, device, browser breakdowns

रिस्पॉन्स

कोड	विवरण
`200`	Account analytics
`401`	Missing or invalid API key
`403`	API key lacks the required scope

सीमाएँ और त्रुटियाँ

हर क्रेडेंशियल पर प्रति मिनट सीमा है। अपना कोटा GET /quota से जाँचें।

क्रेडेंशियल	सीमा
API key या OAuth access token	प्रति मिनट 38 अनुरोध
OAuth ऐप (सभी टोकन मिलाकर)	प्रति मिनट 500 अनुरोध

कोड	अर्थ
`400`	अनुरोध का प्रारूप गलत है या समर्थित नहीं है
`401`	क्रेडेंशियल अनुपस्थित, अमान्य, रद्द या समाप्त है
`403`	क्रेडेंशियल में आवश्यक स्कोप नहीं है
`404`	माँगा गया संसाधन नहीं मिला
`422`	अनुरोध सत्यापन विफल रहा
`429`	दर सीमा पार हो गई