API v2 Shortener

Buat dan kelola link pendek dari aplikasi kamu. Base URL: https://api.s.id/v2. Versi saat ini 2.0.0, dan spesifikasi lengkapnya tersedia dalam format OpenAPI.

Referensi interaktif

Autentikasi

Kirim API key sk_live_... atau access token OAuth 2.0 lewat header Authorization: Bearer. API key dibuat di Dashboard > Developer, dan setiap key hanya bisa memakai scope yang kamu pilih.

Scope	Akses
`links:read`	Lihat daftar dan detail link
`links:write`	Buat dan perbarui link (buat, edit, pulihkan)
`links:archive`	Arsipkan link
`links:analytics`	Lihat statistik klik per link dan jumlah sepanjang waktu

http

Authorization: Bearer sk_live_...

Panduan lengkap autentikasi

Membuat link

Kirim POST /links dengan URL tujuan. Slug dibuat otomatis jika custom_slug tidak diisi.

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]"}'

Field	Tipe	Wajib	Keterangan
`long_url`	`string`	Ya	URL tujuan
`title`	`string`	Tidak	Judul link
`custom_slug`	`string`	Tidak	Slug kustom; dibuat otomatis jika kosong
`password`	`string`	Tidak	Kata sandi untuk melindungi link
`expired_at`	`integer`	Tidak	Waktu kedaluwarsa dalam Unix timestamp (detik)
`domain_alias`	`string`	Tidak	Domain kustom sebagai pengganti s.id

Contoh respons:

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"
}

Daftar endpoint

Links

GET/linksDaftar link

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

Base URL: https://api.s.id/v2 · Scope: links:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`page`	query	`integer`	Tidak
`limit`	query	`integer`	Tidak
`search`	query	`string`	Tidak	Filter by short code or URL

Respons

Kode	Keterangan
`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/linksBuat link

Base URL: https://api.s.id/v2 · Scope: links:write

Body request

Field	Tipe	Wajib	Keterangan
`long_url`	`string`	Ya	The destination (long) URL
`title`	`string`	Tidak
`custom_slug`	`string`	Tidak	Custom short code; auto-generated when omitted
`password`	`string`	Tidak	Optional password to protect the link
`expired_at`	`integer`	Tidak	Optional expiry as a Unix timestamp (seconds)
`domain_alias`	`string`	Tidak	Custom domain to use instead of s.id

Respons

Kode	Keterangan
`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/availablePeriksa ketersediaan slug

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

Base URL: https://api.s.id/v2 · Scope: links:read

Body request

Field	Tipe	Wajib	Keterangan
`short`	`string`	Ya
`domain_alias`	`string`	Tidak	Custom domain, if any

Respons

Kode	Keterangan
`200`	Slug is available
`401`	Missing or invalid API key
`422`	Slug is taken or invalid

GET/links/{short}Ambil link

Base URL: https://api.s.id/v2 · Scope: links:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the link

Respons

Kode	Keterangan
`200`	A single link
`401`	Missing or invalid API key
`404`	Resource not found

PUT/links/{short}Perbarui link

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).

Base URL: https://api.s.id/v2 · Scope: links:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the link

Body request

Field	Tipe	Wajib	Keterangan
`long_url`	`string`	Tidak	New destination URL
`title`	`string`	Tidak
`custom_slug`	`string`	Tidak	Rename the short code (subject to plan quota)
`password`	`string`	Tidak	Set a password (`""` removes existing protection)
`disposable`	`boolean`	Tidak	Mark link as disposable (expires after first click)
`adult`	`boolean`	Tidak	Flag link as adult content
`archive_at`	`string`	Tidak	Schedule auto-archive on this date (YYYY-MM-DD)
`domain_alias`	`string`	Tidak	Change the custom domain (must be owned by the user)

Respons

Kode	Keterangan
`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}Arsipkan link

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

Base URL: https://api.s.id/v2 · Scope: links:archive

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the link

Respons

Kode	Keterangan
`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}/unarchivePulihkan link yang diarsipkan

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

Base URL: https://api.s.id/v2 · Scope: links:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the archived link

Respons

Kode	Keterangan
`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}/statsLinimasa klik link

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

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameter

Field	Lokasi	Tipe	Wajib
`short`	path	`string`	Ya
`start`	query	`string`	Tidak
`end`	query	`string`	Tidak

Respons

Kode	Keterangan
`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/lifetimeJumlah klik sepanjang waktu

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

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya

Respons

Kode	Keterangan
`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/bulkBuat banyak link sekaligus

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.

Base URL: https://api.s.id/v2 · Scope: links:write

Body request

Field	Tipe	Wajib	Keterangan
`links`	`object[]`	Ya

Respons

Kode	Keterangan
`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/userAmbil pengguna terautentikasi

Base URL: https://api.s.id/v2 · Scope: user:read

Respons

Kode	Keterangan
`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/quotaAmbil kuota akun

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

Base URL: https://api.s.id/v2 · Scope: user:read

Respons

Kode	Keterangan
`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/qrAmbil pengaturan QR global

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

Base URL: https://api.s.id/v2 · Scope: qr:read

Respons

Kode	Keterangan
`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/qrSesuaikan pengaturan QR global

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

Base URL: https://api.s.id/v2 · Scope: qr:write

Body request

Field	Tipe	Wajib	Keterangan
`logo`	`string`	Tidak	URL of the logo image embedded in the QR code
`color`	`string`	Tidak	Foreground color as a hex value, e.g. #1a56db

Respons

Kode	Keterangan
`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}/qrAmbil pengaturan QR sebuah link

Returns the QR code settings for a single link.

Base URL: https://api.s.id/v2 · Scope: qr:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the link

Respons

Kode	Keterangan
`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}/qrSesuaikan pengaturan QR sebuah link

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

Base URL: https://api.s.id/v2 · Scope: qr:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`short`	path	`string`	Ya	The short code of the link

Body request

Field	Tipe	Wajib	Keterangan
`logo`	`string`	Tidak	URL of the logo image embedded in the QR code
`color`	`string`	Tidak	Foreground color as a hex value, e.g. #1a56db

Respons

Kode	Keterangan
`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/micrositesDaftar microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`limit`	query	`integer`	Tidak
`after`	query	`string`	Tidak	Cursor for the next page (opaque string from previous response)

Respons

Kode	Keterangan
`200`	List of microsites
`401`	Missing or invalid API key
`403`	API key lacks the required scope

POST/micrositesBuat microsite

Base URL: https://api.s.id/v2 · Scope: microsites:write

Body request

Field	Tipe	Wajib	Keterangan
`slug`	`string`	Ya	URL-safe identifier (alphanumeric + hyphens/underscores)
`title`	`string`	Ya
`kind`	`string`	Ya	Microsite category (e.g. `personal_branding`, `brand`, `other`)
`theme`	`string`	Tidak	Theme slug (optional, defaults to the platform default)

Respons

Kode	Keterangan
`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}Ambil microsite

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya

Respons

Kode	Keterangan
`200`	Microsite detail
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

PUT/microsites/{slug}Perbarui microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya

Body request

Field	Tipe	Wajib	Keterangan
`title`	`string`	Tidak
`description`	`string`	Tidak
`hide`	`boolean`	Tidak	Set `true` to hide the microsite from public (requires plan that supports visibility toggle)

Respons

Kode	Keterangan
`200`	Updated microsite
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

DELETE/microsites/{slug}Hapus microsite

Base URL: https://api.s.id/v2 · Scope: microsites:delete

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya

Respons

Kode	Keterangan
`200`	Microsite deleted
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

POST/microsites/availablePeriksa ketersediaan slug microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Body request

Field	Tipe	Wajib	Keterangan
`slug`	`string`	Ya

Respons

Kode	Keterangan
`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}/componentsDaftar komponen microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya	The slug of the microsite

Respons

Kode	Keterangan
`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}/componentsTambahkan komponen microsite

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).

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya	The slug of the microsite

Body request

Field	Tipe	Wajib	Keterangan
`kind`	`PROFILE \| LINK \| HORIZONTAL_LINK \| TEXT \| IMAGE \| MEDIA \| DIVIDER \| COUNTDOWN \| MAPS \| IMAGE_SLIDE \| CV \| AUTOPLAY_MUSIC \| CONTACT \| CALENDAR \| SHOP_LISTING \| SHOP_ITEM \| SHOP_LEADERBOARD`	Ya	Component kind. The shape of `data` depends on this value.
`data`	`object`	Ya	Kind-specific component data. Its shape depends on `kind`. See the operation description and examples below.
`tag`	`string`	Tidak	Optional grouping tag

Respons

Kode	Keterangan
`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}Perbarui komponen microsite

Updates a single microsite component.

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya	The slug of the microsite
`componentId`	path	`string`	Ya	The component ID

Body request

Field	Tipe	Wajib	Keterangan
`active`	`boolean`	Ya	Whether the component is shown
`kind`	`string`	Ya	Component kind (e.g. `LINK`, `PROFILE`, `TEXT`)
`data`	`object`	Ya	Kind-specific component data

Respons

Kode	Keterangan
`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}Hapus komponen microsite

Deletes a single microsite component.

Base URL: https://api.s.id/v2 · Scope: microsites:delete

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya	The slug of the microsite
`componentId`	path	`string`	Ya	The component ID

Respons

Kode	Keterangan
`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/orderAtur ulang urutan komponen microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`slug`	path	`string`	Ya	The slug of the microsite

Body request

Field	Tipe	Wajib	Keterangan
`orders`	`string[]`	Ya	Component IDs in the desired display order

Respons

Kode	Keterangan
`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.

Base URL: https://api.s.id

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`client_id`	query	`string`	Ya
`redirect_uri`	query	`string`	Ya
`response_type`	query	`code`	Ya
`scope`	query	`string`	Tidak
`state`	query	`string`	Tidak	Recommended. Opaque value for CSRF protection. Returned unchanged in the redirect.

Respons

Kode	Keterangan
`200`	Consent screen data
`400`	Bad request

POST/oauth/tokenExchange code or refresh token

Base URL: https://api.s.id

Body request

Field	Tipe	Wajib
`grant_type`	`authorization_code \| refresh_token`	Tidak
`code`	`string`	Tidak
`redirect_uri`	`string`	Tidak
`client_id`	`string`	Tidak
`client_secret`	`string`	Tidak
`refresh_token`	`string`	Tidak

Respons

Kode	Keterangan
`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).

Base URL: https://api.s.id

Body request

Field	Tipe	Wajib	Keterangan
`token`	`string`	Ya

Respons

Kode	Keterangan
`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.

Base URL: https://api.s.id

Body request

Field	Tipe	Wajib
`token`	`string`	Ya
`client_id`	`string`	Ya
`client_secret`	`string`	Ya

Respons

Kode	Keterangan
`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).

Base URL: https://api.s.id · Scope: user:read

Respons

Kode	Keterangan
`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.

Base URL: https://api.s.id

Respons

Kode	Keterangan
`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).

Base URL: https://api.s.id

Respons

Kode	Keterangan
`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.

Base URL: https://api.s.id

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`clientId`	path	`string`	Ya

Respons

Kode	Keterangan
`200`	App access revoked
`401`	Unauthorized
`404`	App not found

Analytics

GET/statsAnalitik klik tingkat akun

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.

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameter

Field	Lokasi	Tipe	Wajib	Keterangan
`start`	query	`string`	Tidak	Start date (YYYY-MM-DD). Defaults to 30 days ago.
`end`	query	`string`	Tidak	End date (YYYY-MM-DD). Defaults to today.
`additional`	query	`boolean`	Tidak	Include referer, location, device, browser breakdowns

Respons

Kode	Keterangan
`200`	Account analytics
`401`	Missing or invalid API key
`403`	API key lacks the required scope

Batas dan error

Setiap kredensial dibatasi per menit. Cek posisi kuota kamu lewat GET /quota.

Kredensial	Batas
API key atau access token OAuth	38 permintaan per menit
Aplikasi OAuth (gabungan semua token)	500 permintaan per menit

Kode	Artinya
`400`	Permintaan salah format atau tidak didukung
`401`	Kredensial tidak ada, tidak valid, dicabut, atau kedaluwarsa
`403`	Kredensial tidak memiliki scope yang dibutuhkan
`404`	Resource yang diminta tidak ditemukan
`422`	Validasi permintaan gagal
`429`	Batas permintaan terlampaui