Developers

डेवलपर्स के लिए एपीआई संदर्भ

An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user.

शुरू करना

सिस्टम द्वारा संसाधित किए जाने वाले अनुरोधों के लिए एक एपीआई कुंजी की आवश्यकता होती है। एक बार जब उपयोगकर्ता पंजीकृत हो जाता है, तो इस उपयोगकर्ता के लिए एक एपीआई कुंजी स्वचालित रूप से उत्पन्न हो जाती है। प्रत्येक अनुरोध के साथ एपीआई कुंजी भेजी जानी चाहिए (नीचे पूरा उदाहरण देखें)। यदि एपीआई कुंजी नहीं भेजी गई है या समाप्त हो गई है, तो एक त्रुटि होगी। दुरुपयोग को रोकने के लिए कृपया अपनी एपीआई कुंजी को गुप्त रखना सुनिश्चित करें।

प्रमाणीकरण

एपीआई प्रणाली के साथ प्रमाणित करने के लिए, आपको प्रत्येक अनुरोध के साथ अपनी एपीआई कुंजी को प्राधिकरण टोकन के रूप में भेजने की आवश्यकता है। आप नीचे नमूना कोड देख सकते हैं।

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \ 

कीमत सीमा

हमारे एपीआई में इसकी स्थिरता को अधिकतम करने के अनुरोधों में स्पाइक के खिलाफ सुरक्षा के लिए एक दर सीमक है। हमारी दर सीमा वर्तमान में 30 अनुरोध प्रति 1 मिनट पर सीमित है। कृपया ध्यान दिनुहोस् कि सदस्यता लिएको योजना अनुसार दर परिवर्तन हुन सक्छ।

प्रतिक्रिया के साथ कई हेडर भेजे जाएंगे और अनुरोध के बारे में विभिन्न जानकारी निर्धारित करने के लिए इनकी जांच की जा सकती है।

X-RateLimit-Limit: 30X-RateLimit-Remaining: 29X-RateLimit-Reset: TIMESTAMP

रिस्पांस हैंडलिंग

सभी एपीआई प्रतिक्रिया डिफ़ॉल्ट रूप से JSON प्रारूप में लौटा दी जाती है। इसे प्रयोग करने योग्य डेटा में बदलने के लिए, भाषा के अनुसार उपयुक्त फ़ंक्शन का उपयोग करने की आवश्यकता होगी। PHP में, फ़ंक्शन json_decode() का उपयोग डेटा को किसी ऑब्जेक्ट (डिफ़ॉल्ट) या एक सरणी में परिवर्तित करने के लिए किया जा सकता है (दूसरे पैरामीटर को सत्य पर सेट करें)। त्रुटि कुंजी की जांच करना बहुत महत्वपूर्ण है क्योंकि इससे यह जानकारी मिलती है कि कोई त्रुटि हुई या नहीं। आप हेडर कोड भी देख सकते हैं।

{
    "error": 1,
    "message": "An error occurred"
}

खाता

खाता प्राप्त गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/account

खातामा जानकारी प्राप्त गर्न, तपाईं यो अन्तिम बिन्दुमा अनुरोध पठाउन सक्नुहुन्छ र यसले खातामा डेटा फिर्ता गर्नेछ।

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "data": {
        "id": 1,
        "email": "[email protected]",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registered": "2020-11-10 18:01:43"
    }
}

खाता अद्यावधिक गर्नुहोस्

पुट https://urlkai.com/api/account/update

खातामा जानकारी अद्यावधिक गर्न, तपाईं यो अन्त्यबिन्दुमा अनुरोध पठाउन सक्नुहुन्छ र यसले खातामा डेटा अद्यावधिक गर्नेछ।

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]",
    "password": "NewPassword1"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Account has been successfully updated."
}

फाइल

सूची फाइलहरू

गेट गर्नुहोस् https://urlkai.com/api/files?limit=2&page=1

तपाईंको सबै फाइलहरू प्राप्त गर्नुहोस्। तपाईं नाम द्वारा पनि खोजी गर्न सक्नुहुन्छ।

पैरामीटर विवरण
नाम (वैकल्पिक) नामद्वारा फाइलका लागि खोजी गर्नुहोस्
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/uIQuf",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/MyPpJ",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/uChVb",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

फाइल अपलोड गर्नुहोस्

पोस्ट https://urlkai.com/api/files/upload/:filename?name=My+File

पोस्ट बडीको रूपमा बाइनरी डेटा पठाएर फाइल अपलोड गर्नुहोस्। तपाईँले यूआरएलमा :फाइलनाम (उदाहरणका लागि brandkit.zip) को सट्टामा एक्सटेन्सन सहित फाइल नाम पठाउनु आवश्यक छ । तपाईँले निम्न परिमितिहरू पठाएर विकल्पहरू सेट गर्न सक्नुहुन्छ ।

पैरामीटर विवरण
नाम (वैकल्पिक) फाइल नाम
अनुकूल (वैकल्पिक) अनियमित उपनामको सट्टामा अनुकूलन उपनाम ।
डोमेन (वैकल्पिक) अनुकूल डोमेन
पासवर्ड (वैकल्पिक) पासवर्ड सुरक्षा
म्याद समाप्त हुन्छ (वैकल्पिक) डाउनलोड उदाहरणको लागि समाप्ति 2021-09-28
maxdownloads (वैकल्पिक) डाउनलोडको अधिकतम सङ्ख्या
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/NxLyX"
}

अभियान

अभियानहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/campaigns?limit=2&page=1

एपीआई मार्फत तपाईंको अभियानहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "campaigns": [
            {
                "id": 1,
                "name": "Sample Campaign",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook Campaign",
                "public": true,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}

एक अभियान बनाएं

पोस्ट https://urlkai.com/api/campaign/add

यो अन्त्यबिन्दु प्रयोग गरेर अभियान थप्न सकिन्छ ।

पैरामीटर विवरण
नाम (वैकल्पिक) अभियानको नाम
स्लग (वैकल्पिक) रोटेटर स्लग
सार्वजनिक (वैकल्पिक) पहुँच
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
पोस्ट https://urlkai.com/api/campaign/:campaignid/assign/:linkid

यो अन्त्यबिन्दु प्रयोग गरेर एउटा अभियानमा एउटा छोटो लिङ्क असाइन गर्न सकिन्छ । अन्त्यबिन्दुका लागि अभियान आईडी र छोटो लिङ्क आईडी आवश्यक पर्दछ ।

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Link successfully added to the campaign."
}

अभियान अपडेट करें

पुट https://urlkai.com/api/campaign/:id/update

अभियान अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
नाम (आवश्यक) अभियानको नाम
स्लग (वैकल्पिक) रोटेटर स्लग
सार्वजनिक (वैकल्पिक) पहुँच
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 3,
    "domain": "Twitter Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}

अभियान मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/campaign/:id/delete

अभियान मेट्नका लागि, तपाईँले मेट्न अनुरोध पठाउनु पर्दछ ।

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}

कस्टम स्पलैश

अनुकूल स्प्ल्याश सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/splash?limit=2&page=1

To get Splash Pages via the API, you can use this endpoint. You can also filter data (See table for more info).

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

क्यूआर कोड

क्यूआर कोडहरू सूचीबद्ध गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/qr?limit=2&page=1

एपीआई मार्फत तपाईंको क्यूआर कोडहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुनेछ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

एकल क्यूआर कोड प्राप्त गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/qr/:id

एपीआई मार्फत एकल क्यूआर कोडको लागि विवरण प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुनेछ।

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "clicks": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Unknown": "1"
        },
        "topReferrers": {
            "Direct, email and other": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "instagram": 0
        }
    }
}

क्यूआर कोड सिर्जना गर्नुहोस्

पोस्ट https://urlkai.com/api/qr/add

क्यूआर कोड सिर्जना गर्न, तपाईले पोस्ट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
प्रकार (आवश्यक) पाठ | भिकार्ड | लिङ्क | इमेल | फोन | एसएमएस | वाईफाई
डेटा (आवश्यक) क्यूआर कोडभित्र डाटा एम्बेडेड गर्नुपर्नेछ । प्रकारमा निर्भर गर्दै डेटा स्ट्रिङ वा एरे हुन सक्छ
पृष्ठभूमि (वैकल्पिक) आरजीबी रङ जस्तै आरजीबी (255,255,255)
अग्रभूमि (वैकल्पिक) आरजीबी रङ उदाहरणका लागि आरजीबी (०,०,०)
logo (वैकल्पिक) लोगोको मार्ग या त पीएनजी वा जेपीजी
नाम (वैकल्पिक) क्यूआर कोड नाम
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
}

क्यूआर कोड अद्यावधिक गर्नुहोस्

पुट https://urlkai.com/api/qr/:id/update

क्यूआर कोड अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
डेटा (आवश्यक) क्यूआर कोडभित्र डाटा एम्बेडेड गर्नुपर्नेछ । प्रकारमा निर्भर गर्दै डेटा स्ट्रिङ वा एरे हुन सक्छ
पृष्ठभूमि (वैकल्पिक) आरजीबी रङ जस्तै आरजीबी (255,255,255)
अग्रभूमि (वैकल्पिक) आरजीबी रङ उदाहरणका लागि आरजीबी (०,०,०)
logo (वैकल्पिक) लोगोको मार्ग या त पीएनजी वा जेपीजी
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "QR has been updated successfully."
}

क्यूआर कोड मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/qr/:id/delete

क्यूआर कोड मेट्नका लागि डिलिट रिक्वेस्ट पठाउनु पर्छ ।

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}

चैनल

च्यानलहरू सूचीबद्ध गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/channels?limit=2&page=1

एपीआई मार्फत तपाईंको च्यानलहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "name": "Channel 1",
                "description": "Description of channel 1",
                "color": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "name": "Channel 2",
                "description": "Description of channel 2",
                "color": "#FF0000",
                "starred": false
            }
        ]
    }
}

च्यानल वस्तुहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/channel/:id?limit=1&page=1

एपीआई मार्फत चयन गरिएका च्यानलहरूमा वस्तुहरू प्राप्त गर्न, तपाईँले यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ । तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "links",
                "id": 1,
                "title": "My Sample Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

एक चैनल बनाएं

पोस्ट https://urlkai.com/api/channel/add

यो अन्त्यबिन्दु प्रयोग गरेर एउटा च्यानल थप्न सकिन्छ ।

पैरामीटर विवरण
नाम (आवश्यक) च्यानल नाम
वर्णन[सम्पादन गर्ने] (वैकल्पिक) च्यानल वर्णन
रङ (वैकल्पिक) च्यानल बिल्ला रङ (एचईएक्स)
तारांकित (वैकल्पिक) च्यानल स्टार गर्नुहोस् वा नगर्नुहोस् (सही वा गलत)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}

च्यानलमा एउटा वस्तु निर्दिष्ट गर्नुहोस्

पोस्ट https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

च्यानल आईडी, आइटम प्रकार (लिङ्क, बायो वा क्यूआर) र आइटम आईडीको साथ अनुरोध पठाएर कुनै पनि च्यानलमा वस्तु असाइन गर्न सकिन्छ।

पैरामीटर विवरण
:channelid (आवश्यक) च्यानल आईडी
: प्रकार (आवश्यक) लिंक वा बायो वा क्यूआर
:itemid (आवश्यक) वस्तु आईडी
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

चैनल अपडेट करें

पुट https://urlkai.com/api/channel/:id/update

च्यानल अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
नाम (वैकल्पिक) च्यानल नाम
वर्णन[सम्पादन गर्ने] (वैकल्पिक) च्यानल वर्णन
रङ (वैकल्पिक) च्यानल बिल्ला रङ (एचईएक्स)
तारांकित (वैकल्पिक) च्यानल स्टार गर्नुहोस् वा नगर्नुहोस् (सही वा गलत)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Channel has been updated successfully."
}

च्यानल मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/channel/:id/delete

एउटा च्यानल मेट्नका लागि, तपाईँले मेट्न अनुरोध पठाउनु पर्दछ । सबै वस्तुहरू पनि असाइन गरिएको हुनेछ।

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

पिक्सल

पिक्सेल सूची गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/pixels?limit=2&page=1

एपीआई मार्फत तपाईंको पिक्सेल कोडहरू प्राप्त गर्न, तपाईँले यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "pixels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

पिक्सेल सिर्जना गर्नुहोस्

पोस्ट https://urlkai.com/api/pixel/add

यो अन्त्यबिन्दु प्रयोग गरेर पिक्सेल सिर्जना गर्न सकिन्छ । तपाईँले पिक्सेल प्रकार र ट्याग पठाउन आवश्यक छ ।

पैरामीटर विवरण
प्रकार (आवश्यक) जीटीएमपीएक्सेल | ग्यापिक्सेल | fbpixel | शब्दकोश | linkinpixel | ट्विटर पिक्सेल | adrollpixel | कोरापिक्सेल | पिन्टेरेस्ट | बिंग | स्न्यापच्याट | रेडिट | टिकटक
नाम (आवश्यक) तपाईँको पिक्सेलका लागि अनुकूल नाम
ट्याग (आवश्यक) पिक्सेलका लागि ट्याग
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 1
}

पिक्सेल अपडेट करें

पुट https://urlkai.com/api/pixel/:id/update

पिक्सेल अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
नाम (वैकल्पिक) तपाईँको पिक्सेलका लागि अनुकूल नाम
ट्याग (आवश्यक) पिक्सेलका लागि ट्याग
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Pixel has been updated successfully."
}

पिक्सेल मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/pixel/:id/delete

एउटा पिक्सेल मेट्न, तपाईँले मेट्नुहोस् अनुरोध पठाउनु पर्दछ ।

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}

ब्रांडेड डोमेन

ब्रान्डेड डोमेनहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/domains?limit=2&page=1

एपीआई मार्फत तपाईंको ब्रान्डेड डोमेनहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुनेछ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}

ब्रान्डेड डोमेन सिर्जना गर्नुहोस्

पोस्ट https://urlkai.com/api/domain/add

यो अन्त्यबिन्दु प्रयोग गरेर डोमेन थप्न सकिन्छ । कृपया निश्चित गर्नुहोस् कि डोमेन हाम्रो सर्भरमा सही तरिकाले इंगित गरिएको छ।

पैरामीटर विवरण
डोमेन (आवश्यक) एचटीटीपी वा https सहित ब्रान्डेड डोमेन
redirectroot (वैकल्पिक) कसैले तपाईँको डोमेन भ्रमण गर्दा रूट रिडाइरेक्ट गर्नुहोस्
पुनर्निर्देशन404 (वैकल्पिक) अनुकूल 404 पुनर्निर्देशन
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "id": 1
}

डोमेन अपडेट करें

पुट https://urlkai.com/api/domain/:id/update

ब्रान्डेड डोमेन अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
redirectroot (वैकल्पिक) कसैले तपाईँको डोमेन भ्रमण गर्दा रूट रिडाइरेक्ट गर्नुहोस्
पुनर्निर्देशन404 (वैकल्पिक) अनुकूल 404 पुनर्निर्देशन
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Domain has been updated successfully."
}

डोमेन मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/domain/:id/delete

डोमेन मेट्नका लागि, तपाईँले मेट्नुहोस् अनुरोध पठाउनु पर्दछ ।

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

सीटीए ओवरले

सीटीए ओभरले सूची गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/overlay?limit=2&page=1

एपीआई मार्फत सीटीए ओभरलेहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

पैरामीटर विवरण
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

सर्वर प्रतिक्रिया

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "message",
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Contact Page",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}