डेवलपर संदर्भ

URLZ.li API दस्तावेज़

प्रमाणीकरण, छोटे लिंक, फ़ाइल व फ़ोटो अपलोड, क्लिक आँकड़े और सशुल्क लिंक API के तैयार उदाहरण।

01

परिचय

URLZ API से छोटे लिंक, फ़ाइल अपलोड, आँकड़े और सशुल्क पहुँच बनाएँ। यह संदर्भ सर्वर API कुंजी और लॉग-इन खाता सत्र को अलग समझाता है।

सर्वर-से-सर्वर

बैकएंड, ऑटोमेशन या आंतरिक टूल से सक्रिय कुंजी का उपयोग करें।

apikey=YOUR_API_KEY

खाता सत्र

खाता लिंक, अपलोड, आँकड़े और कमाई के लिए Bearer उपयोग करें।

Authorization: Bearer …
02

त्वरित शुरुआत

तीन चरणों में पहला छोटा लिंक बनाएँ, फिर पूरा संदर्भ देखें।

  1. 1
    खाता बनाएँ

    डैशबोर्ड खोलें और API योजना सक्रिय करें।

  2. 2
    API कुंजी कॉपी करें

    इसे केवल सर्वर पर रखें, सार्वजनिक कोड में नहीं।

  3. 3
    अनुरोध भेजें

    गंतव्य भेजें और JSON से result.short_url पढ़ें।

Curl
curl -X POST "https://api.urlz.li/url/create" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  --data-urlencode "fullUrl=https://example.com/private-report"
03

प्रमाणीकरण

URLZ दो प्रमाणीकरण तरीके देता है। अपनी इंटीग्रेशन के अनुसार चुनें।

A

API कुंजी

बैकएंड के लिए URL या फ़ॉर्म में apikey भेजें; कुंजी और सदस्यता सक्रिय हों।

apikey=YOUR_API_KEY
B

Bearer सत्र

खाता सुविधाओं के लिए लॉगिन से टोकन पाएँ और Authorization में भेजें।

Authorization: Bearer SESSION_TOKEN
क्रेडेंशियल सर्वर पर रखें

कुंजी, पासवर्ड या टोकन को JavaScript, लॉग, संस्करण नियंत्रण या सार्वजनिक रिपॉज़िटरी में न रखें।

04

एंडपॉइंट सूची

पैरामीटर और उदाहरण देखने के लिए एंडपॉइंट चुनें।

05

API कुंजी एंडपॉइंट

लिंक बनाने और खोजने की स्थिर सर्वर रूट।

06

खाता एंडपॉइंट

खाता लिंक, अपलोड, क्लिक और हटाना।

POST/mobile/v1/auth/login.php

खाता सत्र खोलें

क्रेडेंशियल के बदले Bearer टोकन देता है।

प्रमाणीकरण नहीं

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
emailemailहाँ—
passwordstringहाँ—
अनुरोध
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
  }
}
POST/mobile/v1/shorten.php

खाता लिंक बनाएँ

सामान्य या पासवर्ड लिंक बनाता है; पासवर्ड पर लॉगिन ज़रूरी है।

वैकल्पिक Bearer टोकन

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
urlURLहाँ—
passwordstring (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
}
POST/mobile/v1/upload.php

फ़ाइल या फ़ोटो अपलोड

10 MB तक समर्थित फ़ाइल अपलोड करता है।

वैकल्पिक Bearer टोकन

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
filemultipart fileहाँ—
kindphoto | documentनहींdocument
passwordstring (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
}
GET/mobile/v1/clicks.php

क्लिक आँकड़े देखें

क्लिक, विज़िटर, देश और पहुँच रिकॉर्ड देता है।

Bearer

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
linkIdintegerहाँ—
limitinteger (1–100)नहीं100
offsetintegerनहीं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": []
}
07

URLZ Chat & Request

Add private conversations, collect requested documents, schedule reminders and track submissions.

POST/mobile/v1/collaboration/configure.php

Enable 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

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
hashstringहाँ—
chat.enabledbooleanनहींfalse
request.enabledbooleanनहींfalse
request.titlestringनहीं—
request.itemsstring[]नहीं[]
request.recipientsemail[]नहीं[]
request.deadlineISO datetimeनहीं—
request.paymentRequiredbooleanनहीं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}
GET/mobile/v1/collaboration/chats.php

List link conversations

Return chat-enabled links and message totals. Add id to retrieve messages.

Bearer

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
idintegerनहीं—
afterintegerनहीं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":[]}]}
GET/mobile/v1/collaboration/requests.php

Track document requests

List requests, expected items, recipients, submissions and secure files. Add id for full detail.

Bearer

पैरामीटर

पैरामीटरप्रकारज़रूरीडिफ़ॉल्ट
idintegerनहीं—
अनुरोध
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}]}
08

त्रुटियाँ और HTTP कोड

आधुनिक एंडपॉइंट message और API कुंजी रूट error देते हैं। हमेशा HTTP स्थिति का उपयोग करें।

{ "message": "A valid link is required." }{ "error": "Invalid API key" }
200
सफल

अनुरोध पूरा हुआ।

201
बनाया गया

लिंक या फ़ाइल बनी।

400
अमान्य अनुरोध

JSON या सिंटैक्स अमान्य।

401
प्रमाणीकरण ज़रूरी

टोकन गायब या समाप्त।

403
अनुमति नहीं

कुंजी, योजना या खाते को अनुमति नहीं।

404
नहीं मिला

संसाधन मौजूद नहीं।

409
टकराव

माँगी स्थिति में टकराव।

422
जाँच विफल

फ़ील्ड गायब या अमान्य।

429
बहुत अनुरोध

गति घटाकर फिर प्रयास करें।

500/503
सर्वर अनुपलब्ध

बाद में idempotent तरीके से प्रयास करें।

09

सुरक्षा और सीमाएँ

प्रोडक्शन में ये नियम अपनाएँ।

  • केवल HTTPS का उपयोग करें।
  • API कुंजियाँ निजी रखें और नियमित रूप से बदलें।
  • उपयोगकर्ता द्वारा दिए गए पैरामीटर जाँचें और एन्कोड करें।
  • सूची और लॉग अनुरोधों में पेजिनेशन उपयोग करें।
  • अनुशंसित अधिकतम: प्रति कुंजी प्रति सेकंड 10 अनुरोध।
इंटीग्रेशन में मदद चाहिए?

एंडपॉइंट, HTTP स्थिति और बिना क्रेडेंशियल वाला उदाहरण भेजें।

iPHONE के लिए URLZ

नया iOS संस्करण जल्द आ रहा है

iPhone के लिए अपडेट किया गया URLZ ऐप अंतिम चरण में है और अगले कुछ दिनों में App Store पर उपलब्ध होगा। आपके धैर्य के लिए धन्यवाद।