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 मिनट पर सीमित है। Sila ambil perhatian bahawa kadar mungkin berubah mengikut pelan yang dilanggan.

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

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

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

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

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

Dapatkan Akaun

MENDAPATKAN https://urlkai.com/api/account

Untuk mendapatkan maklumat tentang akaun, anda boleh menghantar permintaan ke titik akhir ini dan ia akan mengembalikan data pada akaun.

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"
    }
}

Kemas kini Akaun

MELETAKKAN https://urlkai.com/api/account/update

Untuk mengemas kini maklumat pada akaun, anda boleh menghantar permintaan ke titik akhir ini dan ia akan mengemas kini data pada akaun.

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."
}

Senarai Fail

MENDAPATKAN https://urlkai.com/api/files?limit=2&page=1

Dapatkan semua fail anda. Anda juga boleh mencari mengikut nama.

पैरामीटर विवरण
Nama (pilihan) Cari fail mengikut nama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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\/xHYpE",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/LGpIT",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/snImW",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Muat naik fail

POST https://urlkai.com/api/files/upload/:filename?name=My+File

Muat naik fail dengan menghantar data binari sebagai isi siaran. Anda perlu menghantar nama fail termasuk sambungan dan bukannya :nama fail dalam url (cth. brandkit.zip). Anda boleh menetapkan pilihan dengan menghantar parameter berikut.

पैरामीटर विवरण
Nama (pilihan) Nama fail
Tersuai (pilihan) Alias tersuai dan bukannya alias rawak.
Domain (pilihan) Domain Tersuai
Kata laluan (pilihan) Perlindungan kata laluan
Tamat tempoh (pilihan) Tamat tempoh untuk contoh muat turun 2021-09-28
muat turun maksimum (pilihan) Bilangan muat turun maksimum
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\/BxzUV"
}

अभियान

Kempen Senarai

MENDAPATKAN https://urlkai.com/api/campaigns?limit=2&page=1

Untuk mendapatkan kempen anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

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

POST https://urlkai.com/api/campaign/add

Kempen boleh ditambah menggunakan titik akhir ini.

पैरामीटर विवरण
Nama (pilihan) Nama kempen
siput (pilihan) Siput Rotator
Awam (pilihan) Akses
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"
}
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Pautan pendek boleh diperuntukkan kepada kempen menggunakan titik akhir ini. Titik akhir memerlukan ID kempen dan ID pautan pendek.

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."
}

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

MELETAKKAN https://urlkai.com/api/campaign/:id/update

Untuk mengemas kini kempen, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Nama (diperlukan) Nama kempen
siput (pilihan) Siput Rotator
Awam (pilihan) Akses
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"
}

Padamkan Kempen

MENGHAPUSKAN https://urlkai.com/api/campaign/:id/delete

Untuk memadamkan kempen, anda perlu menghantar permintaan 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."
}

कस्टम स्पलैश

Senarai Percikan Tersuai

MENDAPATKAN 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).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

क्यूआर कोड

Senaraikan kod QR

MENDAPATKAN https://urlkai.com/api/qr?limit=2&page=1

Untuk mendapatkan kod QR anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

Dapatkan satu Kod QR

MENDAPATKAN https://urlkai.com/api/qr/:id

Untuk mendapatkan butiran bagi satu kod QR melalui API, anda boleh menggunakan titik akhir ini.

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
        }
    }
}

Buat Kod QR

POST https://urlkai.com/api/qr/add

Untuk membuat Kod QR, anda perlu menghantar data yang sah dalam JSON melalui permintaan POST. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Jenis Teks (diperlukan) | vcard | pautan | E-mel | Telefon | SMS | Wifi
Data (diperlukan) Data untuk dibenamkan di dalam kod QR. Data boleh menjadi rentetan atau tatasusunan bergantung pada jenis
Latar belakang (pilihan) Warna RGB cth rgb (255,255,255)
latar depan (pilihan) Warna RGB cth rgb (0,0,0)
Logo (pilihan) Laluan ke logo sama ada png atau jpg
Nama (pilihan) Nama kod QR
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"
}

Kemas kini Kod QR

MELETAKKAN https://urlkai.com/api/qr/:id/update

Untuk mengemas kini Kod QR, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Data (diperlukan) Data untuk dibenamkan di dalam kod QR. Data boleh menjadi rentetan atau tatasusunan bergantung pada jenis
Latar belakang (pilihan) Warna RGB cth rgb (255,255,255)
latar depan (pilihan) Warna RGB cth rgb (0,0,0)
Logo (pilihan) Laluan ke logo sama ada png atau jpg
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."
}

Padamkan Kod QR

MENGHAPUSKAN https://urlkai.com/api/qr/:id/delete

Untuk memadamkan kod QR, anda perlu menghantar permintaan 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."
}

चैनल

Senarai Saluran

MENDAPATKAN https://urlkai.com/api/channels?limit=2&page=1

Untuk mendapatkan saluran anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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
            }
        ]
    }
}

Senaraikan Item Saluran

MENDAPATKAN https://urlkai.com/api/channel/:id?limit=1&page=1

Untuk mendapatkan item dalam saluran terpilih melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

एक चैनल बनाएं

POST https://urlkai.com/api/channel/add

Saluran boleh ditambah menggunakan titik akhir ini.

पैरामीटर विवरण
Nama (diperlukan) Nama saluran
Keterangan (pilihan) Penerangan saluran
Warna (pilihan) Warna lencana saluran (HEX)
dibintangi (pilihan) Bintang saluran atau tidak (benar atau palsu)
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
}

Tetapkan Item ke Saluran

POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Item boleh diberikan kepada mana-mana saluran dengan menghantar permintaan dengan id saluran, jenis item (pautan, bio atau qr) dan id item.

पैरामीटर विवरण
:channelid (diperlukan) ID Saluran
:Jenis (Diperlukan) pautan atau bio atau QR
:itemid (diperlukan) Item ID
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."
}

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

MELETAKKAN https://urlkai.com/api/channel/:id/update

Untuk mengemas kini saluran, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Nama (pilihan) Nama saluran
Keterangan (pilihan) Penerangan saluran
Warna (pilihan) Warna lencana saluran (HEX)
dibintangi (pilihan) Bintang saluran atau tidak (benar atau palsu)
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."
}

Padam Saluran

MENGHAPUSKAN https://urlkai.com/api/channel/:id/delete

Untuk memadamkan saluran, anda perlu menghantar permintaan DELETE. Semua item juga tidak akan ditugaskan.

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."
}

पिक्सल

Senarai Piksel

MENDAPATKAN https://urlkai.com/api/pixels?limit=2&page=1

Untuk mendapatkan kod piksel anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

Cipta piksel

POST https://urlkai.com/api/pixel/add

Piksel boleh dibuat menggunakan titik akhir ini. Anda perlu menghantar jenis piksel dan tag.

पैरामीटर विवरण
Jenis (diperlukan) gtmpixel | Gapixel | fbpixel | AdwordsPixel | LinkedInInPixel | Piksel Twitter | adrollpixel | Quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
Nama (diperlukan) Nama tersuai untuk piksel anda
tag (diperlukan) Tag untuk piksel
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
}

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

MELETAKKAN https://urlkai.com/api/pixel/:id/update

Untuk mengemas kini piksel, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Nama (pilihan) Nama tersuai untuk piksel anda
tag (diperlukan) Tag untuk piksel
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."
}

Padamkan Piksel

MENGHAPUSKAN https://urlkai.com/api/pixel/:id/delete

Untuk memadamkan piksel, anda perlu menghantar permintaan 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."
}

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

Senaraikan Domain Berjenama

MENDAPATKAN https://urlkai.com/api/domains?limit=2&page=1

Untuk mendapatkan domain berjenama anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}

Buat Domain Berjenama

POST https://urlkai.com/api/domain/add

Domain boleh ditambah menggunakan titik akhir ini. Sila pastikan domain dihalakan dengan betul ke pelayan kami.

पैरामीटर विवरण
Domain (diperlukan) Domain berjenama termasuk http atau https
redirectroot (pilihan) Ubah hala akar apabila seseorang melawat domain anda
lencongan404 (pilihan) Lencongan 404 tersuai
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
}

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

MELETAKKAN https://urlkai.com/api/domain/:id/update

Untuk mengemas kini domain berjenama, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
redirectroot (pilihan) Ubah hala akar apabila seseorang melawat domain anda
lencongan404 (pilihan) Lencongan 404 tersuai
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."
}

Padamkan Domain

MENGHAPUSKAN https://urlkai.com/api/domain/:id/delete

Untuk memadamkan domain, anda perlu menghantar permintaan 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."
}

सीटीए ओवरले

Senaraikan Tindanan CTA

MENDAPATKAN https://urlkai.com/api/overlay?limit=2&page=1

Untuk mendapatkan tindanan cta melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

पैरामीटर विवरण
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
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"
            }
        ]
    }
}