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\/kokMp",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/tsqiB",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/ISWiN",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Загрузить файл

ПОМЕСТИТЬ https://urlkai.com/api/files/upload/:filename?name=My+File

Загрузите файл, отправив двоичные данные в качестве тела сообщения. Вам нужно отправить имя файла с расширением вместо :filename в URL (например, brandkit.zip). Вы можете задать параметры, отправив следующие параметры.

पैरामीटर विवरण
имя (необязательно) Имя файла
обычай (необязательно) Пользовательский псевдоним вместо случайного псевдонима.
домен (необязательно) Пользовательский домен
пароль (необязательно) Защита паролем
истечение (необязательно) Срок действия примера для скачивания 2021-09-28
максзагрузок (необязательно) Максимальное количество загрузок
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\/SYvTT"
}

अभियान

Список кампаний

ПОЛУЧИТЬ https://urlkai.com/api/campaigns?limit=2&page=1

Чтобы получать свои рассылки через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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

Чтобы обновить кампанию, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
имя (обязательно) Название кампании
слизняк (необязательно) Вращательный слаг
общественный (необязательно) Доступ
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

Чтобы удалить рассылку, нужно отправить запрос 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"
            }
        ]
    }
}

क्यूआर कोड

Список QR-кодов

ПОЛУЧИТЬ https://urlkai.com/api/qr?limit=2&page=1

Чтобы получить QR-коды через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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"
            }
        ]
    }
}

Получите один QR-код

ПОЛУЧИТЬ https://urlkai.com/api/qr/:id

Чтобы получить сведения об одном QR-коде через API, вы можете использовать эту конечную точку.

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

Создание QR-кода

ПОМЕСТИТЬ https://urlkai.com/api/qr/add

Чтобы создать QR-код, вам нужно отправить действительные данные в формате JSON через POST-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
тип (обязательный) текст | VCARD | ссылка | Электронная почта | Телефон | смс | Wi-Fi
данные (обязательно) Данные должны быть встроены в QR-код. Данные могут быть строковыми или массивными в зависимости от типа
фон (необязательно) Цвет RGB, например, rgb (255,255,255)
передний план (необязательно) Цвет RGB, например, rgb(0,0,0)
лого (необязательно) Путь к логотипу либо png, либо jpg
имя (необязательно) Название 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"
}

Обновить QR-код

КЛАСТЬ https://urlkai.com/api/qr/:id/update

Чтобы обновить QR-код, нужно отправить действительные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
данные (обязательно) Данные должны быть встроены в QR-код. Данные могут быть строковыми или массивными в зависимости от типа
фон (необязательно) Цвет RGB, например, rgb (255,255,255)
передний план (необязательно) Цвет RGB, например, rgb(0,0,0)
лого (необязательно) Путь к логотипу либо png, либо 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."
}

Удаление QR-кода

УДАЛИТЬ https://urlkai.com/api/qr/:id/delete

Чтобы удалить QR-код, нужно отправить запрос 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

Чтобы получить свои каналы через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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

Чтобы получить элементы в выбранных каналах через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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

С помощью этой конечной точки можно добавить канал.

पैरामीटर विवरण
имя (обязательно) Название канала
описание (необязательно) Описание канала
Цвет (необязательно) Цвет значка канала (HEX)
усеянный (необязательно) Помечать канал звездочкой или нет (верно или ложно)
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

Элемент может быть назначен любому каналу, отправив запрос с идентификатором канала, типом элемента (ссылки, биография или qr) и идентификатором элемента.

पैरामीटर विवरण
:channelid (обязательно) Идентификатор канала
:тип (обязательные) ссылки или биография или QR
:itemid (обязательно) 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."
}

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

КЛАСТЬ https://urlkai.com/api/channel/:id/update

Чтобы обновить канал, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
имя (необязательно) Название канала
описание (необязательно) Описание канала
Цвет (необязательно) Цвет значка канала (HEX)
усеянный (необязательно) Помечать канал звездочкой или нет (верно или ложно)
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

Чтобы удалить канал, нужно отправить запрос 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

Чтобы получить коды пикселей через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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

С помощью этой конечной точки можно создать пиксель. Вам нужно отправить тип пикселя и тег.

पैरामीटर विवरण
тип (обязательно) gtmpixel | Гапиксель | FBPIXEL | adwordspixel | linkedinpixel | Твиттерпиксель | 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

Чтобы обновить пиксель, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
имя (необязательно) Пользовательское имя для пикселя
ярлык (обязательно) Тег для пикселя
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

Чтобы удалить пиксель, нужно отправить запрос 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

Чтобы получить свои брендированные домены через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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

Домен может быть добавлен с помощью этой конечной точки. Пожалуйста, убедитесь, что домен правильно указан на наш сервер.

पैरामीटर विवरण
домен (обязательно) Брендированный домен, включающий http или 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

Чтобы обновить брендированный домен, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
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

Чтобы удалить домен, необходимо отправить запрос 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."
}

सीटीए ओवरले

Список оверлеев CTA

ПОЛУЧИТЬ https://urlkai.com/api/overlay?limit=2&page=1

Чтобы получить оверлеи cta через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

पैरामीटर विवरण
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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"
            }
        ]
    }
}