API Reference

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

प्रमाणीकरण

प्रत्येक request में अपनी API key को Bearer token के रूप में पास करें।

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

प्रत्येक key scoped है। किसी endpoint के लिए request जिसका आवश्यक scope गायब है, 403 insufficient_scope लौटाता है।

Method	Path	Description	Scope
GET	/links	List links	`links:read`
POST	/links	Create a link	`links:write`
POST	/links/available	Check slug availability	`links:read`
GET	/links/{short}	Get a link	`links:read`
PUT	/links/{short}	Update a link	`links:write`
DELETE	/links/{short}	Archive a link	`links:archive`
POST	/links/{short}/unarchive	Restore an archived link	`links:write`
GET	/links/{short}/stats	Link click timeline	`links:analytics`
GET	/links/{short}/stats/lifetime	Lifetime click count	`links:analytics`
POST	/links/bulk	Bulk create links	`links:write`

Method	Path	Description	Scope
GET	/user	Get authenticated user	`user:read`
GET	/quota	Get account quota	`user:read`

Method	Path	Description	Scope
GET	/microsites	List microsites	`microsites:read`
POST	/microsites	Create a microsite	`microsites:write`
GET	/microsites/{slug}	Get a microsite	`microsites:read`
PUT	/microsites/{slug}	Update a microsite	`microsites:write`
DELETE	/microsites/{slug}	Delete a microsite	`microsites:write`
POST	/microsites/available	Check microsite slug availability	`microsites:read`
GET	/microsites/{slug}/components	List microsite components	`microsites:read`
POST	/microsites/{slug}/components	Add a microsite component	`microsites:write`
PUT	/microsites/{slug}/components/{componentId}	Update a microsite component	`microsites:write`
DELETE	/microsites/{slug}/components/{componentId}	Delete a microsite component	`microsites:write`
POST	/microsites/{slug}/components/order	Reorder microsite components	`microsites:write`

Method	Path	Description	Scope
GET	/stats	Account-level click analytics	`links:analytics`

Method	Path	Description	Scope
GET	/qr	Get global QR settings	`qr:read`
PUT	/qr	Customize global QR settings	`qr:write`
GET	/links/{short}/qr	Get a link's QR settings	`qr:read`
PUT	/links/{short}/qr	Customize a link's QR settings	`qr:write`

Method	Path	Description
GET	/oauth/authorize	Get consent screen data
POST	/oauth/token	Exchange code or refresh token
POST	/oauth/revoke	Revoke a token
GET	/oauth/userinfo	Get authorized user profile
GET	/api/user/oauth/apps	List apps authorized by the current user
DELETE	/api/user/oauth/apps/{clientId}	Revoke all tokens for an app

links:readList and read links

links:writeCreate and update links (create, edit, restore)

links:archiveArchive links

links:analyticsRead per-link click statistics and lifetime counts

qr:readRead QR code settings (global and per-link)

qr:writeCustomize QR code settings (global and per-link)

user:readRead the authenticated user profile and account quota

microsites:readRead microsites

microsites:writeCreate, update, delete and manage components of microsites

प्रति API key 38 requests प्रति मिनट। सीमा से अधिक होने पर HTTP 429 लौटाता है।

Status	Meaning
200	Success
400	Bad request — check your parameters
401	Missing or invalid API key
403	Forbidden — key lacks required scope (insufficient_scope)
404	Resource not found
429	Rate limit exceeded
500	Server error — retry with backoff