Developers

Referensi API untuk Pengembang

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.

Мулай

Kunci API diperlukan agar permintaan diproses oleh sistem. Setelah pengguna mendaftar, kunci API secara otomatis dibuat untuk pengguna ini. Kunci API harus dikirim dengan setiap permintaan (lihat contoh lengkap di bawah). Jika kunci API tidak dikirim atau kedaluwarsa, akan terjadi kesalahan. Pastikan untuk merahasiakan kunci API Anda untuk mencegah penyalahgunaan.

Аутентикаси

Untuk mengautentikasi dengan sistem API, Anda perlu mengirim kunci API sebagai token otorisasi dengan setiap permintaan. Anda dapat melihat contoh kode di bawah ini.

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

Батас Тариф

API kami memiliki pembatas kecepatan untuk melindungi dari lonjakan permintaan untuk memaksimalkan stabilitasny. Pembatas tarif kami saat ini dibatasi pada 30 permintaan per 1 menit. Обратите внимание, что тариф может меняться в зависимости от подписанного плана.

Beberapa tajuk akan dikirim bersama respons dan ini dapat diperiksa untuk menentukan berbagai informasi tentang permintaan.

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

Пенангананский респон

Semua respons API dikembalikan dalam format JSON secara default. Untuk mengubah ini menjadi data yang dapat digunakan, fungsi yang sesuai perlu digunakan sesuai dengan bahasa. Di PHP, fungsi json_decode() dapat digunakan untuk mengonversi data menjadi objek (default) atau array (setel parameter kedua ke true). Sangat penting untuk memeriksa kunci kesalahan karena memberikan informasi apakah ada kesalahan atau tidak. Anda juga dapat memeriksa kode header.

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

Акун

Дапаткан Акун

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

Untuk mendapatkan informasi tentang akun, Anda dapat mengirim permintaan ke titik akhir ini dan itu akan mengembalikan data pada akun.

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

Perbaharui akun

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

Untuk memperbarui informasi di akun, Anda dapat mengirim permintaan ke titik akhir ini dan itu akan memperbarui data di akun.

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

Домен Bermerek

Список брендированных доменов

ПОЛУЧИТЬ 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."
}

Файлы

Список файлов

ПОЛУЧИТЬ 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\/RkGrW",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/iRFRj",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/lkwTW",
            "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\/QELRy"
}

Хампаран CTA

Список оверлеев 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"
            }
        ]
    }
}

Кампанье

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

ПОЛУЧИТЬ 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."
}

Коде QR

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

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

Untuk mendapatkan kode QR Anda melalui API, Anda dapat menggunakan titik akhir ini. Anda juga dapat memfilter data (Lihat tabel untuk info selengkapnya).

Параметр Кетеранган
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
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 Kode QR

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

Untuk mendapatkan detail untuk satu kode QR melalui API, Anda dapat 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 Kode 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

Untuk memperbarui Kode QR, Anda perlu mengirim data yang valid di JSON melalui permintaan PUT. Data harus dikirim sebagai badan mentah permintaan Anda seperti yang ditunjukkan di bawah ini. Contoh di bawah ini menunjukkan semua parameter yang dapat Anda kirim tetapi Anda tidak diharuskan untuk mengirim semua (Lihat tabel untuk info lebih lanjut).

Параметр Кетеранган
данные (обязательно) Данные должны быть встроены в 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

Untuk menghapus kode QR, Anda perlu mengirim 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."
}

Пембука Кустом

Список пользовательских заставок

ПОЛУЧИТЬ 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/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/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."
}