एपीआई दस्तावेज़ीकरण

यह उपलब्ध API endpoints के लिए दस्तावेज़ीकरण है, जो REST architecture के आसपास बनाए गए हैं। सभी API endpoints एक JSON response लौटाएंगे जिसमें मानक HTTP response codes होंगे और एक API Key के माध्यम से Bearer Authentication की आवश्यकता होगी।

 

प्रमाणीकरण

सभी एपीआई एंडपॉइंट्स को बियर ऑथेंटिकेशन विधि द्वारा भेजे गए एपीआई कुंजी की आवश्यकता होती है।

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://u.page/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "\u0906\u092a\u0915\u094b API \u0924\u0915 \u092a\u0939\u0941\u0901\u091a \u0928\u0939\u0940\u0902 \u0939\u0948",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
All API endpoint results work with the UTC timezone unless specified otherwise.
उपयोगकर्ता
लिंक
आंकड़े
स्प्लैश पेज
कस्टम QR कोड
ईमेल हस्ताक्षर
एकत्रित डेटा
Notification handlers
कस्टम डोमेन्स
मेरा खाता टीम्स
टीम सदस्य
टीम के सदस्य
खाता बिलिंग
Referred signups
खाता लॉग