REST API

Базовый адрес: https://urlik.xyz/api/. Ответы — JSON вида:

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

Аутентификация (необязательна для базового сокращения) — заголовок X-Api-Key. Ключ доступен в личном кабинете. Ссылки, созданные с ключом, привязываются к вашему аккаунту.

Эндпоинты

POST /api/getLink.json

Создать короткую ссылку.

Параметр	Обязательность	Описание
`url`	обязательный	целевой URL (http/https)
`alias`	необяз.	свой код, 2–32 симв. `[a-zA-Z0-9_-]`
`mode`	необяз.	`redirect` (по умолч.), `preview`, `frame`
`expire`	необяз.	срок жизни в секундах (0 — без срока)
`password`	необяз.	пароль для перехода

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

Статистика по ссылке. Параметр code — короткий код. Возвращает количество переходов, ряд по дням, источники, устройства и браузеры.

POST /api/links.json

Список ваших ссылок. Требует X-Api-Key.

POST /api/update.json

Изменить ссылку (code + поля url, mode, expire, password). Требует ключ/сессию.

POST /api/delete.json

Удалить ссылку (code). Требует X-Api-Key или сессию владельца.

QR-код и временная почта

Эти методы требуют заголовок X-Api-Key (ключ — в личном кабинете).

Метод	Параметры	Описание
`GET /api/qr.json`	`data`*, `format`, `fg`, `bg`, `ecc`, `size`	QR-код: `format` = `png`/`svg`, цвета `fg`/`bg`
`GET /api/mailbox.json`	`address` или `username`	получить или создать временный адрес
`GET /api/messages.json`	`address`	список писем во временном ящике
`GET /api/message.json`	`address`, `id`	прочитать одно письмо

Простой REST API для коротких ссылок

REST API Urlik позволяет создавать, читать, обновлять и удалять короткие ссылки из вашего собственного кода и получать статистику кликов в формате JSON. Это обычный HTTPS API — отправьте POST-запрос и получите предсказуемый JSON-ответ — поэтому он работает из любого языка или платформы.

Для базового сокращения учётные данные не нужны. Чтобы привязывать ссылки к вашему аккаунту и управлять ими позже, отправляйте свой ключ в заголовке X-Api-Key, который находится в вашем аккаунте. Ответы всегда следуют одному и тому же формату со статусом, сообщением и полем return, показанному ниже.

Нужен ли мне ключ API?

Для базового сокращения — нет, ссылку можно создать анонимно. Ключ, который есть в вашем аккаунте, привязывает ссылки к вам и требуется, чтобы просматривать, обновлять или удалять их.

В каком формате приходят ответы?

Каждая конечная точка возвращает JSON со статусом, понятным человеку сообщением и объектом return, содержащим данные, поэтому разбор ответов одинаков для всех вызовов.

Есть ли ограничение по частоте запросов?

Да, запросы ограничиваются по частоте для каждого вызывающего, чтобы сервис оставался быстрым и справедливым. Аутентифицированные ключи получают больший лимит, чем анонимный трафик.

Можно ли использовать его из любого языка?

Да. Это стандартный HTTPS JSON API, поэтому им может пользоваться всё, что умеет отправлять POST-запрос — curl, Python, PHP, JavaScript или Go.