REST API

Base URL: https://urlik.xyz/api/. Responses are JSON of the form:

{ "status": "success", "message": "...", "return": { ... } }

Authentication (optional for basic shortening) — the X-Api-Key header. Your key is in your account. Links created with a key are attached to your account.

Endpoints

POST /api/getLink.json

Create a short link.

ParameterRequiredDescription
urlrequiredtarget URL (http/https)
aliasoptionalcustom code, 2–32 chars [a-zA-Z0-9_-]
modeoptionalredirect (default), preview, frame
expireoptionallifetime in seconds (0 = never)
passwordoptionalpassword to follow the link
curl -X POST https://urlik.xyz/api/getLink.json \
 -H "X-Api-Key: YOUR_KEY" \
 -d "url=https://example.com/very/long/path" \
 -d "mode=redirect"
{ "status":"success", "return":{
 "hex":"a1b2c3", "url":"https://urlik.xyz/a1b2c3",
 "qr":"https://urlik.xyz/qr/a1b2c3.png",
 "stats":"https://urlik.xyz/a1b2c3+", "mode":"redirect" } }

POST /api/stats.json

Stats for a link. The code parameter is the short code. Returns the click count, a daily series, sources, devices and browsers.

POST /api/links.json

List your links. Requires X-Api-Key.

POST /api/update.json

Update a link (code + fields url, mode, expire, password). Requires a key/session.

POST /api/delete.json

Delete a link (code). Requires X-Api-Key or the owner's session.

Media downloader, QR codes and temporary email

These methods require the X-Api-Key header (your key is in your account) or a call through RapidAPI.

MethodParametersDescription
GET /api/download.jsonurl*download video/photo from 1000+ sites (TikTok, YouTube, Instagram…): returns formats with ready signed download links (MP4/MP3/image)
GET /api/qr.jsondata*, format, fg, bg, ecc, sizeQR code: format = png/svg, colors fg/bg
GET /api/mailbox.jsonaddress or usernameget or create a temporary address
GET /api/messages.jsonaddresslist messages in a temporary inbox
GET /api/message.jsonaddress, idread a single message

Essayer en direct

Explorez et appelez chaque endpoint ici même. Collez votre clé API via le bouton Authorize pour lancer des requêtes authentifiées.

Intégrer le raccourcisseur

Déposez cet extrait sur n’importe quelle page pour ajouter un raccourcisseur d’URL fonctionnel avec un lien vers urlik.xyz :

<iframe src="https://urlik.xyz/embed" style="width:100%;max-width:520px;height:150px;border:0" title="URL shortener by urlik.xyz" loading="lazy"></iframe>

/embed ↗

Une API REST simple pour les liens courts

L’API REST d’Urlik vous permet de créer, lire, mettre à jour et supprimer des liens courts depuis votre propre code et de récupérer les statistiques de clics en JSON. C’est une API HTTPS toute simple — envoyez une requête POST, recevez une réponse JSON prévisible — qui fonctionne donc depuis n’importe quel langage ou plateforme.

Le raccourcissement basique ne nécessite aucun identifiant. Pour rattacher les liens à votre compte et les gérer plus tard, envoyez votre clé dans l’en-tête X-Api-Key, disponible dans votre compte. Les réponses suivent toujours la même structure status, message et return présentée ci-dessous.

Ai-je besoin d’une clé API ?

Pas pour le raccourcissement basique — vous pouvez créer un lien anonymement. Une clé, disponible dans votre compte, rattache les liens à votre profil et est requise pour les lister, les mettre à jour ou les supprimer.

Dans quel format sont les réponses ?

Chaque endpoint renvoie du JSON avec un status, un message lisible et un objet return contenant les données, pour un parsing cohérent d’un appel à l’autre.

Y a-t-il une limite de requêtes ?

Oui, les requêtes sont limitées par appelant pour garder le service rapide et équitable. Les clés authentifiées bénéficient d’un quota plus élevé que le trafic anonyme.

Puis-je l’utiliser depuis n’importe quel langage ?

Oui. C’est une API JSON HTTPS standard : tout ce qui peut envoyer une requête POST — curl, Python, PHP, JavaScript ou Go — peut l’utiliser.

À quelles recherches cette page répond