API Kompatibel YOURLS

S.EE menyediakan endpoint API yang kompatibel dengan YOURLS, sehingga Anda dapat menggunakan S.EE dengan klien pihak ketiga dan integrasi yang sudah mendukung API YOURLS.

Endpoint ini dirancang untuk memudahkan migrasi dari YOURLS atau untuk mengintegrasikan S.EE ke alat automasi, ekstensi browser, dan aplikasi yang sudah menggunakan protokol API YOURLS.

Endpoint API

https://s.ee/api/v1/yourls

Cakupan Kompatibilitas

Endpoint ini mengimplementasikan lapisan kompatibilitas parsial untuk YOURLS API.

Didukung

action=shorturl
Autentikasi signature
Format output: json, jsonp, xml, simple
Permintaan GET dan POST

Tidak Didukung

Autentikasi username / password
Aksi YOURLS lain seperti expand, stats, atau db-stats
Operasi administratif atau terkait database

Saat ini hanya fungsi pemendekan URL yang disediakan.

Autentikasi

Hanya autentikasi signature yang didukung. Autentikasi username/password tidak tersedia.

Parameter signature adalah kunci API令牌 S.EE Anda.

Anda dapat membuat dan mengelola API token di:

https://s.ee/user/developers/

API token terikat pada pengguna yang terautentikasi dan mewarisi izin serta batasan yang sama dengan akun tersebut.

Aksi yang Didukung

Saat ini, hanya aksi berikut yang didukung:

Aksi	Deskripsi
`shorturl`	Membuat URL pendek untuk tautan tertentu

Parameter

Parameter	Wajib	Deskripsi
`signature`	Ya	kunci API令牌 S.EE Anda
`action`	Ya	Aksi yang akan dijalankan (saat ini hanya `shorturl`)
`url`	Ya	URL yang akan dipendekkan
`format`	Tidak	Format output: `json`, `jsonp`, `xml`, atau `simple` (default: `simple`)
`keyword`	Tidak	Slug kustom untuk URL pendek
`title`	Tidak	Judul untuk URL pendek

Catatan

Jika keyword yang diberikan sudah digunakan, API akan otomatis membuat keyword baru yang tersedia alih-alih mengembalikan error.
Aturan validasi dan pencegahan penyalahgunaan standar S.EE berlaku untuk semua permintaan.

Contoh

Permintaan POST

curl -X POST \
  'https://s.ee/api/v1/yourls' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'signature=your_api_token' \
  --data-urlencode 'format=json' \
  --data-urlencode 'action=shorturl' \
  --data-urlencode 'url=https://example.com/'

Respons:

{
  "status": "success",
  "code": "",
  "message": "https://example.com/ added to database",
  "errorCode": "",
  "statusCode": "200",
  "url": {
    "keyword": "link",
    "url": "https://example.com/",
    "title": "",
    "date": "2026-01-14 21:38:10",
    "ip": "192.0.2.2"
  },
  "shorturl": "https://s.ee/link"
}

Beberapa field respons dipertahankan demi kompatibilitas YOURLS dan bisa saja kosong.

Permintaan GET

curl -X GET "https://s.ee/api/v1/yourls?action=shorturl&format=simple&signature=your_api_token&url=https://example.com/"

Respons:

https://s.ee/link

Pastikan Anda melakukan URL-encode terhadap parameter saat menggunakan GET request.
Untuk URL panjang atau parameter tambahan, POST request disarankan agar tidak terkena batas panjang URL.

Klien Pihak Ketiga

API ini kompatibel dengan klien apa pun yang mendukung pemendekan URL gaya YOURLS, termasuk:

Ekstensi browser
Aplikasi seluler
Aplikasi desktop
Alat automasi (Shortcuts, Tasker, Zapier, dan lainnya)

Untuk detail lengkap spesifikasi API YOURLS asli, lihat dokumentasi resminya:

https://yourls.org/readme.html#API

API Kompatibel YOURLS

Di halaman ini