परिचय
URLZ API से छोटे लिंक, फ़ाइल अपलोड, आँकड़े और सशुल्क पहुँच बनाएँ। यह संदर्भ सर्वर API कुंजी और लॉग-इन खाता सत्र को अलग समझाता है।
सर्वर-से-सर्वर
बैकएंड, ऑटोमेशन या आंतरिक टूल से सक्रिय कुंजी का उपयोग करें।
apikey=YOUR_API_KEYखाता सत्र
खाता लिंक, अपलोड, आँकड़े और कमाई के लिए Bearer उपयोग करें।
Authorization: Bearer …त्वरित शुरुआत
तीन चरणों में पहला छोटा लिंक बनाएँ, फिर पूरा संदर्भ देखें।
- 1खाता बनाएँ
डैशबोर्ड खोलें और API योजना सक्रिय करें।
- 2API कुंजी कॉपी करें
इसे केवल सर्वर पर रखें, सार्वजनिक कोड में नहीं।
- 3अनुरोध भेजें
गंतव्य भेजें और JSON से result.short_url पढ़ें।
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 कुंजी
बैकएंड के लिए URL या फ़ॉर्म में apikey भेजें; कुंजी और सदस्यता सक्रिय हों।
apikey=YOUR_API_KEYBearer सत्र
खाता सुविधाओं के लिए लॉगिन से टोकन पाएँ और 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छोटा लिंक बनाएँ
सक्रिय API कुंजी से छोटा 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 MB तक समर्थित फ़ाइल अपलोड करता है।
वैकल्पिक 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 MB तक सशुल्क लिंक बनाता है।
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 या सिंटैक्स अमान्य।
टोकन गायब या समाप्त।
कुंजी, योजना या खाते को अनुमति नहीं।
संसाधन मौजूद नहीं।
माँगी स्थिति में टकराव।
फ़ील्ड गायब या अमान्य।
गति घटाकर फिर प्रयास करें।
बाद में idempotent तरीके से प्रयास करें।
सुरक्षा और सीमाएँ
प्रोडक्शन में ये नियम अपनाएँ।
- केवल HTTPS का उपयोग करें।
- API कुंजियाँ निजी रखें और नियमित रूप से बदलें।
- उपयोगकर्ता द्वारा दिए गए पैरामीटर जाँचें और एन्कोड करें।
- सूची और लॉग अनुरोधों में पेजिनेशन उपयोग करें।
- अनुशंसित अधिकतम: प्रति कुंजी प्रति सेकंड 10 अनुरोध।
एंडपॉइंट, HTTP स्थिति और बिना क्रेडेंशियल वाला उदाहरण भेजें।
