YOURLS-kompatibelt API

S.EE erbjuder en YOURLS-kompatibel API-endpoint så att du kan använda S.EE med befintliga tredjepartsklienter och integrationer som stöder YOURLS-API:t.

Den här endpointen är utformad för att förenkla migrering från YOURLS och för att integrera S.EE i automatiseringsverktyg, webbläsartillägg och applikationer som redan talar YOURLS-protokollet.

API-endpoint

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

Omfattning av kompatibiliteten

Den här endpointen implementerar ett delvis kompatibilitetslager för YOURLS API.

Stöds

action=shorturl
signature-autentisering
Svarsformat: json, jsonp, xml, simple
GET- och POST-begäranden

Stöds inte

username / password-autentisering
Andra YOURLS-åtgärder som expand, stats eller db-stats
Administrativa eller databasrelaterade åtgärder

Endast funktionen för URL-förkortning tillhandahålls.

Autentisering

Endast signature-autentisering stöds. Autentisering med användarnamn och lösenord finns inte.

Parametern signature är din S.EE API-token.

Du kan skapa och hantera din API-token här:

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

API-token är knuten till den autentiserade användaren och ärver samma behörigheter och begränsningar som kontot.

Åtgärder som stöds

För närvarande stöds bara följande åtgärd:

Åtgärd	Beskrivning
`shorturl`	Skapa en kort URL för en given länk

Parametrar

Parameter	Krävs	Beskrivning
`signature`	Ja	Din S.EE API-token
`action`	Ja	Åtgärden som ska utföras, för närvarande bara `shorturl`
`url`	Ja	URL:en som ska förkortas
`format`	Nej	Utdataformat: `json`, `jsonp`, `xml` eller `simple` (standard: `simple`)
`keyword`	Nej	Anpassad slug för den korta URL:en
`title`	Nej	Titel för den korta URL:en

Kommentarer

Om ett angivet keyword redan används genererar API:t automatiskt ett nytt ledigt keyword i stället för att returnera ett fel.
S.EE:s vanliga regler för missbruksskydd och validering gäller för alla förfrågningar.

Exempel

POST-begäran

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/'

Svar:

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

Vissa svarsfält finns kvar för kompatibilitet med YOURLS och kan därför vara tomma.

GET-begäran

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

Svar:

https://s.ee/link

Kom ihåg att URL-koda parametrarna när du använder GET-begäranden. För långa URL:er eller extra parametrar rekommenderas POST för att undvika längdbegränsningar i URL:er.

Tredjepartsklienter

Det här API:t är kompatibelt med alla klienter som stöder YOURLS-liknande URL-förkortning, bland annat:

Webbläsartillägg
Mobilappar
Skrivbordsappar
Automatiseringsverktyg som Shortcuts, Tasker och Zapier

För fullständig information om den ursprungliga YOURLS-specifikationen, se den officiella dokumentationen:

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

YOURLS-kompatibelt API

På denna sida