Обзор
Создавайте короткие ссылки, загрузки, статистику и платный доступ через API URLZ. Здесь отдельно описаны серверные интеграции по API-ключу и авторизованные сессии аккаунта.
Сервер-сервер
Используйте активный ключ в backend, автоматизации или внутреннем инструменте.
apikey=YOUR_API_KEYСессия аккаунта
Используйте Bearer для ссылок, загрузок, статистики и монетизации.
Authorization: Bearer …Быстрый старт
Создайте первую короткую ссылку за три шага, затем используйте полную справку.
- 1Создайте аккаунт
Откройте панель и активируйте тариф API.
- 2Скопируйте API-ключ
Храните его на сервере, а не в открытом коде.
- 3Отправьте запрос
Передайте адрес и прочитайте result.short_url из JSON.
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/private-report"
// Server-side JavaScript (Node.js)
const body = new URLSearchParams({
apikey: 'YOUR_API_KEY',
fullUrl: 'https://example.com/private-report'
});
const response = await fetch('https://api.urlz.li/url/create', {
method: 'POST',
body
});
const data = await response.json();
console.log(data.result.short_url);
$request = curl_init('https://api.urlz.li/url/create');
curl_setopt_array($request, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query([
'apikey' => 'YOUR_API_KEY',
'fullUrl' => 'https://example.com/private-report',
]),
CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($request), true, 512, JSON_THROW_ON_ERROR);
echo $data['result']['short_url'];
import requests
response = requests.post(
"https://api.urlz.li/url/create",
data={
"apikey": "YOUR_API_KEY",
"fullUrl": "https://example.com/private-report",
},
timeout=15,
)
response.raise_for_status()
print(response.json()["result"]["short_url"])
Аутентификация
URLZ поддерживает два способа аутентификации. Выберите подходящий.
API-ключ
Для backend. Передайте apikey в URL или форме; ключ и подписка должны быть активны.
apikey=YOUR_API_KEYСессия Bearer
Для функций аккаунта. Получите токен через вход и передайте его в Authorization.
Authorization: Bearer SESSION_TOKENНе публикуйте ключи, пароли и токены в JavaScript, логах, системе версий и открытых репозиториях.
Список эндпоинтов
Выберите эндпоинт, чтобы посмотреть параметры и примеры.
/url/createСоздать короткую ссылку
GET/url/listПоказать и отфильтровать ссылки
POST/mobile/v1/auth/login.phpОткрыть сессию аккаунта
POST/mobile/v1/shorten.phpСоздать ссылку аккаунта
POST/mobile/v1/upload.phpЗагрузить файл или фото
GET/mobile/v1/links.phpПоказать ссылки аккаунта
GET/mobile/v1/clicks.phpПолучить статистику кликов
DELETE/mobile/v1/delete-link.phpУдалить ссылку
POST/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
GET/mobile/v1/collaboration/chats.phpList link conversations
GET/mobile/v1/collaboration/requests.phpTrack document requests
POST/mobile/v1/monetization/links.phpСоздать или преобразовать платную ссылку
POST/mobile/v1/monetization/upload.phpСоздать платный файл или фото
GET/mobile/v1/monetization/links.phpПоказать платные ссылки
GET/mobile/v1/monetization/transactions.phpПоказать продажи
Эндпоинты API-ключа
Стабильные серверные маршруты для создания и поиска ссылок.
/url/createСоздать короткую ссылку
Создаёт короткий URL с активным ключом.
apikeyПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
apikey | string | Да | — |
fullUrl | URL | Да | — |
encrypt | string | Нет | "" |
password | string | Нет | "" |
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/report.pdf"
{
"result": {
"short_url": "https://urlz.li/7b3c2e5a",
"hash": "7b3c2e5a",
"date": "2026-11-02",
"time": "14:32:10"
}
}
/url/listПоказать и отфильтровать ссылки
Возвращает ссылки с фильтрами и пагинацией.
apikeyПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
apikey | string | Да | — |
limit | integer (1–1000) | Нет | 100 |
offset | integer | Нет | 0 |
order | asc | desc | Нет | desc |
date | YYYY-MM-DD | Нет | — |
from_date | YYYY-MM-DD | Нет | — |
to_date | YYYY-MM-DD | Нет | — |
url_destination | string | Нет | — |
hash | string | Нет | — |
curl -G "https://api.urlz.li/url/list" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "limit=25" \
--data-urlencode "order=desc"
{
"result": {
"filters": { "limit": 25, "offset": 0, "order": "desc" },
"total": 42,
"count": 25,
"items": [
{
"id": 1204,
"date": "2026-11-02",
"time": "14:32:10",
"destination": "https://example.com/report.pdf",
"hash": "7b3c2e5a",
"hash_retour": "https://urlz.li/7b3c2e5a"
}
]
}
}
Эндпоинты аккаунта
Ссылки, загрузки, клики и удаление.
/mobile/v1/auth/login.phpОткрыть сессию аккаунта
Обменивает данные аккаунта на Bearer-токен.
Без аутентификацииПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
email | Да | — | |
password | string | Да | — |
curl -X POST "https://api.urlz.li/mobile/v1/auth/login.php" \
-H "Content-Type: application/json" \
-d '{"email":"developer@example.com","password":"YOUR_PASSWORD"}'
{
"token": "SESSION_TOKEN",
"user": {
"id": 42,
"email": "developer@example.com",
"apiKey": "ACCOUNT_API_KEY",
"planActive": true
}
}
/mobile/v1/shorten.phpСоздать ссылку аккаунта
Создаёт обычную или защищённую ссылку; при пароле нужна авторизация.
Необязательный Bearer-токенПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
url | URL | Да | — |
password | string (min. 4) | Нет | — |
curl -X POST "https://api.urlz.li/mobile/v1/shorten.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/private","password":"safe-pass"}'
{
"shortUrl": "https://urlz.li/Ab3dE91x",
"destination": "https://example.com/private",
"hash": "Ab3dE91x",
"protected": true
}
/mobile/v1/upload.phpЗагрузить файл или фото
Загружает разрешённый файл до 10 МБ.
Необязательный Bearer-токенПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
file | multipart file | Да | — |
kind | photo | document | Нет | document |
password | string (min. 4) | Нет | — |
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./photo.jpg" \
-F "kind=photo"
{
"shortUrl": "https://urlz.li/P8kLm21q",
"destination": "https://urlz.li/cloud/app/photo_….jpg",
"hash": "P8kLm21q",
"protected": false
}
/mobile/v1/links.phpПоказать ссылки аккаунта
Возвращает ссылки, клики, защиту и статус монетизации.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
limit | integer (1–100) | Нет | 100 |
offset | integer | Нет | 0 |
curl "https://api.urlz.li/mobile/v1/links.php?limit=25&offset=0" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 1204,
"shortUrl": "https://urlz.li/7b3c2e5a",
"destination": "https://example.com/report.pdf",
"protected": false,
"monetized": true,
"clicks": 18
}
],
"total": 42,
"summary": { "totalLinks": 42, "totalClicks": 304, "clicksLast7Days": 28 }
}
/mobile/v1/clicks.phpПолучить статистику кликов
Возвращает клики, посетителей, страны и события доступа.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
linkId | integer | Да | — |
limit | integer (1–100) | Нет | 100 |
offset | integer | Нет | 0 |
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"link": { "id": 1204, "shortUrl": "https://urlz.li/7b3c2e5a" },
"summary": {
"totalClicks": 18,
"uniqueVisitors": 14,
"clicksLast24Hours": 2,
"clicksLast7Days": 9
},
"countries": [{ "country": "France", "countryCode": "FR", "clicks": 8 }],
"items": []
}
/mobile/v1/delete-link.phpУдалить ссылку
Удаляет только ссылку авторизованного аккаунта.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
hash | string | Да | — |
curl -X DELETE "https://api.urlz.li/mobile/v1/delete-link.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a"}'
{
"ok": true,
"message": "Link deleted."
}
URLZ Chat & Request
Add private conversations, collect requested documents, schedule reminders and track submissions.
/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
Attach a private conversation and/or a document request to an existing account link. A Bearer session token or API key is accepted.
Bearer or API keyПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
hash | string | Да | — |
chat.enabled | boolean | Нет | false |
request.enabled | boolean | Нет | false |
request.title | string | Нет | — |
request.items | string[] | Нет | [] |
request.recipients | email[] | Нет | [] |
request.deadline | ISO datetime | Нет | — |
request.paymentRequired | boolean | Нет | false |
curl -X POST "https://api.urlz.li/mobile/v1/collaboration/configure.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a","chat":{"enabled":true},"request":{"enabled":true,"title":"Accounting documents","items":["Invoices","Bank statement"]}}'
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
/mobile/v1/collaboration/chats.phpList link conversations
Return chat-enabled links and message totals. Add id to retrieve messages.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
id | integer | Нет | — |
after | integer | Нет | 0 |
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
/mobile/v1/collaboration/requests.phpTrack document requests
List requests, expected items, recipients, submissions and secure files. Add id for full detail.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
id | integer | Нет | — |
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
Эндпоинты платных ссылок
Создавайте платный доступ и получайте данные продаж.
/mobile/v1/monetization/links.phpСоздать или преобразовать платную ссылку
Создаёт платный URL или преобразует существующую ссылку.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
destination | URL | Нет | — |
existingLinkId | integer | Нет | — |
title | string (max. 180) | Да | — |
description | string (max. 3000) | Нет | — |
price | decimal | Да | — |
currency | EUR | USD | Да | USD |
accessPolicy | permanent | timed | limited | Нет | permanent |
accessDurationHours | integer (1–8760) | Нет | 24 |
maxAccesses | integer (1–1000) | Нет | 1 |
locale | ISO 639-1 | Нет | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"destination":"https://example.com/private-course",
"title":"Private course access",
"description":"One-time access to the course.",
"price":"9.90",
"currency":"EUR",
"accessPolicy":"permanent",
"locale":"en"
}'
{
"id": 91,
"hash": "cd3ed9a4",
"shortUrl": "https://urlz.li/cd3ed9a4",
"paywallUrl": "https://urlz.li/en/pay/cd3ed9a4/",
"converted": false
}
/mobile/v1/monetization/upload.phpСоздать платный файл или фото
Приватно хранит файл и создаёт платную ссылку, до 50 МБ.
BearerПараметры
| Параметр | Тип | Обязательный | По умолчанию |
|---|---|---|---|
file | multipart file | Да | — |
kind | photo | file | Нет | file |
title | string (max. 180) | Да | — |
description | string (max. 3000) | Нет | — |
price | decimal | Да | — |
currency | EUR | USD | Да | USD |
accessPolicy | permanent | timed | limited | Нет | permanent |
locale | ISO 639-1 | Нет | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./premium-photo.jpg" \
-F "kind=photo" \
-F "title=Premium event photo" \
-F "price=4.90" \
-F "currency=EUR"
{
"id": 92,
"hash": "e71f8a20",
"shortUrl": "https://urlz.li/e71f8a20",
"paywallUrl": "https://urlz.li/en/pay/e71f8a20/"
}
/mobile/v1/monetization/links.phpПоказать платные ссылки
Возвращает платные ссылки, продажи, валовый и чистый доход.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 91,
"shortUrl": "https://urlz.li/cd3ed9a4",
"kind": "url",
"priceMinor": 990,
"currency": "EUR",
"status": "active",
"sales": 4,
"grossMinor": 3960,
"netMinor": 3374
}
]
}
/mobile/v1/monetization/transactions.phpПоказать продажи
Возвращает заказы, комиссии, чистый доход и даты разблокировки.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/transactions.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"orderNumber": "LNK-20261102-8F3C21",
"grossMinor": 990,
"platformFeeMinor": 69,
"processorFeeMinor": 45,
"netMinor": 876,
"currency": "EUR",
"status": "paid",
"fundsAvailableAt": "2026-11-16 14:32:10",
"fundsStatus": "held"
}
]
}
Ошибки и HTTP-коды
Современные эндпоинты возвращают message, маршруты API-ключа — error. Ориентируйтесь на HTTP-статус.
{ "message": "A valid link is required." }{ "error": "Invalid API key" }Запрос выполнен.
Ссылка или файл созданы.
Некорректный JSON или синтаксис.
Токен отсутствует или истёк.
Ключ, тариф или аккаунт не имеют доступа.
Ресурс не существует.
Запрошенное состояние конфликтует.
Поля отсутствуют или неверны.
Снизьте частоту и повторите позже.
Повторите позже идемпотентно.
Безопасность и ограничения
Применяйте эти правила в рабочей среде.
- Используйте только HTTPS.
- Храните API-ключи в тайне и регулярно обновляйте их.
- Проверяйте и кодируйте параметры, введённые пользователями.
- Используйте пагинацию для списков и журналов.
- Рекомендуемый максимум: 10 запросов в секунду на один ключ.
Пришлите эндпоинт, HTTP-статус и очищенный пример без учётных данных.
