Developers

開発者向け API リファレンス

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.

ການ ເລີ່ມຕົ້ນ

ຕ້ອງມີກະແຈ API ສໍາລັບຄໍາຮ້ອງຂໍທີ່ລະບົບຈະດໍາເນີນການ. ເມື່ອຜູ້ໃຊ້ລົງທະບຽນແລ້ວ, ກະແຈ API ຈະຖືກສ້າງຂຶ້ນໂດຍອັດຕະໂນມັດສໍາລັບຜູ້ໃຊ້ຄົນນີ້. ຕ້ອງສົ່ງກະແຈ API ພ້ອມກັບຄໍາຮ້ອງຂໍແຕ່ລະເທື່ອ (ເບິ່ງຕົວຢ່າງເຕັມທີ່ທາງລຸ່ມນີ້). ຖ້າກະແຈ API ບໍ່ຖືກສົ່ງຫຼືຫມົດອາຍຸ, ຈະມີຂໍ້ຜິດພາດ. ກະລຸນາໃຫ້ແນ່ໃຈວ່າໄດ້ເກັບກະແຈ API ຂອງທ່ານໄວ້ເປັນຄວາມລັບເພື່ອປ້ອງກັນການທໍາຮ້າຍ.

ການຢັ້ງຢືນ

ເພື່ອຢືນຢັນກັບລະບົບ API, ທ່ານຕ້ອງສົ່ງກະແຈ API ຂອງທ່ານເປັນໂປຣແກຣມອະນຸຍາດກັບແຕ່ລະຄໍາຮ້ອງຂໍ. ທ່ານສາມາດເບິ່ງຕົວຢ່າງໂປຣແກຣມທາງລຸ່ມນີ້.

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

ອັດຕາຈໍາກັດ

API ຂອງພວກເຮົາມີລະບົບຈໍາກັດອັດຕາເພື່ອປ້ອງກັນການຮ້ອງຂໍທີ່ເພີ່ມຂຶ້ນເພື່ອໃຫ້ຄວາມຫມັ້ນຄົງສູງສຸດ. ປະຈຸບັນນີ້ມີການຈໍາກັດອັດຕາການຮ້ອງຂໍ 30 ເທື່ອຕໍ່ 1 ນາທີ. ຂໍໃຫ້ສັງເກດວ່າອັດຕາອາດປ່ຽນແປງຕາມແຜນທີ່ຈົດທະບຽນ.

ຫົວ ຂໍ້ ຫລາຍ ຢ່າງ ຈະ ຖືກ ສົ່ງ ໄປ ພ້ອມ ກັບ ການ ຕອບ ຮັບ ແລະ ສິ່ງ ເຫລົ່າ ນີ້ ສາມາດ ຖືກ ກວດ ສອບ ເພື່ອ ກໍານົດ ຂໍ້ ມູນ ຕ່າງໆ ກ່ຽວ ກັບ ຄໍາ ຂໍ ຮ້ອງ.

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

ການຈັດການກັບການຕອບສະຫນອງ

ການຕອບສະຫນອງ API ທັງຫມົດຈະຖືກສົ່ງຄືນໃນຮູບແບບ JSON ຕາມມາດຕະຖານ. ເພື່ອປ່ຽນເປັນຂໍ້ມູນທີ່ໃຊ້ໄດ້, ຫນ້າທີ່ທີ່ເຫມາະສົມຈະຕ້ອງໃຊ້ຕາມພາສາ. ໃນ PHP, function json_decode() ສາມາດໃຊ້ເພື່ອປ່ຽນຂໍ້ມູນເປັນວັດຖຸ (ມາດຕະຖານ) ຫຼື array (ຕັ້ງ parameter ທີສອງເປັນ true). ມັນສໍາຄັນຫຼາຍທີ່ຈະກວດເບິ່ງກະແຈຄວາມຜິດພາດເພາະມັນໃຫ້ຂໍ້ມູນວ່າມີຂໍ້ຜິດພາດຫຼືບໍ່. ທ່ານຍັງສາມາດກວດເບິ່ງລະຫັດຫົວຂໍ້ໄດ້.

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

ບັນຊີ

ຮັບ ເອົາ ບັນຊີ

ຮັບ https://urlkai.com/api/account

ເພື່ອຈະໄດ້ຂໍ້ມູນກ່ຽວກັບບັນຊີ, ທ່ານສາມາດສົ່ງຄໍາຮ້ອງຂໍໄປຫາ endpoint ນີ້ ແລະ ມັນຈະສົ່ງຄືນຂໍ້ມູນໃນບັນຊີ.

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

ເພື່ອປັບປຸງຂໍ້ມູນໃນບັນຊີ, ທ່ານສາມາດສົ່ງຄໍາຮ້ອງຂໍໄປຫາ endpoint ນີ້ແລະມັນຈະປັບປຸງຂໍ້ມູນໃນບັນຊີ.

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

Branded Domains

ລາຍຊື່ Branded Domains

ຮັບ https://urlkai.com/api/domains?limit=2&page=1

ເພື່ອຈະໄດ້ຮັບ branded domains ຂອງເຈົ້າຜ່ານ 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"
            }
        ]
    }
}

ສ້າງ Domain ທີ່ ມີ ຊື່ ສຽງ

ໂພສ https://urlkai.com/api/domain/add

ສາມາດເພີ່ມໂດເມນໄດ້ໂດຍໃຊ້ຈຸດສຸດທ້າຍນີ້. ກະລຸນາໃຫ້ແນ່ໃຈວ່າ domain ຖືກຊີ້ໄປຫາ server ຂອງພວກເຮົາຢ່າງຖືກຕ້ອງ.

พารามิเตอร์ ຄໍາອະທິບາຍ
ໂດເມນ (ຈໍາເປັນ) Branded domain ລວມທັງ http ຫຼື https
redirectroot (ເລືອກ) Root redirect ເມື່ອມີຄົນມາຢ້ຽມຢາມໂດເມນຂອງເຈົ້າ
ປ່ຽນແປງ404 (ເລືອກ) Custom 404 redirect
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

ເພື່ອປັບປຸງ branded domain, ທ່ານຕ້ອງສົ່ງຂໍ້ມູນທີ່ຖືກຕ້ອງໃນ JSON ຜ່ານຄໍາຮ້ອງຂໍ PUT. ຂໍ້ມູນຕ້ອງຖືກສົ່ງເປັນເນື້ອໃນຂອງຄໍາຮ້ອງຂໍຂອງທ່ານດັ່ງທີ່ສະແດງໄວ້ທາງລຸ່ມນີ້. ຕົວຢ່າງທາງລຸ່ມນີ້ສະແດງໃຫ້ເຫັນຕົວເລກທັງຫມົດທີ່ທ່ານສາມາດສົ່ງໄດ້ແຕ່ທ່ານບໍ່ຈໍາເປັນຕ້ອງສົ່ງທັງຫມົດ (ເບິ່ງຕາຕະລາງສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ).

พารามิเตอร์ ຄໍາອະທິບາຍ
redirectroot (ເລືອກ) Root redirect ເມື່ອມີຄົນມາຢ້ຽມຢາມໂດເມນຂອງເຈົ້າ
ປ່ຽນແປງ404 (ເລືອກ) Custom 404 redirect
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 Overlays

ລາຍການ CTA Overlays

ຮັບ https://urlkai.com/api/overlay?limit=2&page=1

ເພື່ອຈະໄດ້ cta overlays ຜ່ານ 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"
            }
        ]
    }
}

Custom Splash

ລາຍການ Custom Splash

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

ອັບໂຫຼດແຟ້ມ

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

ອັບໂຫຼດແຟ້ມໂດຍສົ່ງຂໍ້ມູນສອງເປັນເນື້ອໃນຂອງບົດຄວາມ. ທ່ານຕ້ອງສົ່ງຊື່ແຟ້ມລວມທັງຂະຫຍາຍຕົວແທນ :filename ໃນ url (ຕົວຢ່າງ: brandkit.zip). ທ່ານສາມາດຕັ້ງທາງເລືອກໄດ້ໂດຍການສົ່ງຕົວເລກດັ່ງຕໍ່ໄປນີ້.

พารามิเตอร์ ຄໍາອະທິບາຍ
ຊື່ (ເລືອກ) ຊື່ແຟ້ມ
ທໍານຽມ (ເລືອກ) ຊື່ຫລິ້ນແບບສະເພາະແທນຊື່ຫລິ້ນແບບບັງເອີນ.
ໂດເມນ (ເລືອກ) Custom Domain
ລະຫັດຜ່ານ (ເລືອກ) ການປົກປ້ອງລະຫັດຜ່ານ
ການສິ້ນສຸດ (ເລືອກ) ການສິ້ນສຸດຂອງຕົວຢ່າງການດາວໂຫຼດ 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\/NVjPv"
}

QRコード

ລາຍການ QR code

ຮັບ 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 Code ດຽວ

ຮັບ https://urlkai.com/api/qr/:id

ເພື່ອຈະໄດ້ຮັບລາຍລະອຽດສໍາລັບ QR code ດຽວຜ່ານ 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 Code

ໂພສ https://urlkai.com/api/qr/add

ເພື່ອສ້າງ QR Code, ທ່ານຕ້ອງສົ່ງຂໍ້ມູນທີ່ຖືກຕ້ອງໃນ JSON ຜ່ານຄໍາຮ້ອງຂໍ POST. ຂໍ້ມູນຕ້ອງຖືກສົ່ງເປັນເນື້ອໃນຂອງຄໍາຮ້ອງຂໍຂອງທ່ານດັ່ງທີ່ສະແດງໄວ້ທາງລຸ່ມນີ້. ຕົວຢ່າງທາງລຸ່ມນີ້ສະແດງໃຫ້ເຫັນຕົວເລກທັງຫມົດທີ່ທ່ານສາມາດສົ່ງໄດ້ແຕ່ທ່ານບໍ່ຈໍາເປັນຕ້ອງສົ່ງທັງຫມົດ (ເບິ່ງຕາຕະລາງສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ).

พารามิเตอร์ ຄໍາອະທິບາຍ
ປະເພດ (ຈໍາເປັນ) text | vcard | ລິ້ງ | ອີເມວ | ໂທລະສັບ | ສື່ສານ | ອິນ ເຕີ ແນັດ
ຂໍ້ມູນ (ຈໍາເປັນ) ຂໍ້ ມູນ ທີ່ ຈະ ຝັງ ຢູ່ ໃນ QR code. ຂໍ້ມູນສາມາດເປັນເຊື້ອສາຍຫຼື array ຂຶ້ນກັບປະເພດ
ພູມຫຼັງ (ເລືອກ) ສີ RGB ຕົວຢ່າງ: rgb(255,255,255)
ເບື້ອງຫນ້າ (ເລືອກ) ສີ RGB ຕົວຢ່າງ: rgb(0,0,0)
ໂລໂກ້ (ເລືອກ) ເສັ້ນທາງໄປສູ່ໂລໂກ້ png ຫຼື jpg
ຊື່ (ເລືອກ) ຊື່ QR Code
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 Code

ໃສ່ https://urlkai.com/api/qr/:id/update

ເພື່ອປັບປຸງ QR Code, ທ່ານຕ້ອງສົ່ງຂໍ້ມູນທີ່ຖືກຕ້ອງໃນ JSON ຜ່ານຄໍາຮ້ອງຂໍ PUT. ຂໍ້ມູນຕ້ອງຖືກສົ່ງເປັນເນື້ອໃນຂອງຄໍາຮ້ອງຂໍຂອງທ່ານດັ່ງທີ່ສະແດງໄວ້ທາງລຸ່ມນີ້. ຕົວຢ່າງທາງລຸ່ມນີ້ສະແດງໃຫ້ເຫັນຕົວເລກທັງຫມົດທີ່ທ່ານສາມາດສົ່ງໄດ້ແຕ່ທ່ານບໍ່ຈໍາເປັນຕ້ອງສົ່ງທັງຫມົດ (ເບິ່ງຕາຕະລາງສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ).

พารามิเตอร์ ຄໍາອະທິບາຍ
ຂໍ້ມູນ (ຈໍາເປັນ) ຂໍ້ ມູນ ທີ່ ຈະ ຝັງ ຢູ່ ໃນ QR code. ຂໍ້ມູນສາມາດເປັນເຊື້ອສາຍຫຼື array ຂຶ້ນກັບປະເພດ
ພູມຫຼັງ (ເລືອກ) ສີ 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 Code

ລຶບ https://urlkai.com/api/qr/:id/delete

ເພື່ອລຶບລະຫັດ QR, ທ່ານຕ້ອງສົ່ງຄໍາຮ້ອງຂໍລຶບ.

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

ໂຄງການໂຄສະນາສາມາດເພີ່ມຂຶ້ນໄດ້ໂດຍໃຊ້ຈຸດສຸດທ້າຍນີ້.

พารามิเตอร์ ຄໍາອະທິບາຍ
ຊື່ (ເລືອກ) ຊື່ໂຄງການ
slug (ເລືອກ) Rotator Slug
ສາທາລະນະ (ເລືອກ) ການເຂົ້າເຖິງ
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

ສາມາດມອບຫມາຍການເຊື່ອມຕໍ່ສັ້ນໆໃຫ້ແກ່ໂຄງການໂດຍໃຊ້ຈຸດສຸດທ້າຍນີ້. ຈຸດ ສຸດ ທ້າຍ ຮຽກ ຮ້ອງ ID ໂຄງ ການ ແລະ ID link ສັ້ນໆ.

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. ຂໍ້ມູນຕ້ອງຖືກສົ່ງເປັນເນື້ອໃນຂອງຄໍາຮ້ອງຂໍຂອງທ່ານດັ່ງທີ່ສະແດງໄວ້ທາງລຸ່ມນີ້. ຕົວຢ່າງທາງລຸ່ມນີ້ສະແດງໃຫ້ເຫັນຕົວເລກທັງຫມົດທີ່ທ່ານສາມາດສົ່ງໄດ້ແຕ່ທ່ານບໍ່ຈໍາເປັນຕ້ອງສົ່ງທັງຫມົດ (ເບິ່ງຕາຕະລາງສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ).

พารามิเตอร์ ຄໍາອະທິບາຍ
ຊື່ (ຈໍາເປັນ) ຊື່ໂຄງການ
slug (ເລືອກ) Rotator Slug
ສາທາລະນະ (ເລືອກ) ການເຂົ້າເຖິງ
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/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

ລາຍການສາມາດຖືກມອບຫມາຍໃຫ້ກັບຊ່ອງໃດໆກໍໄດ້ໂດຍການສົ່ງຄໍາຮ້ອງຂໍພ້ອມກັບ id ຊ່ອງ, ປະເພດລາຍການ (link, bio ຫຼື qr) ແລະ item id.

พารามิเตอร์ ຄໍາອະທິບາຍ
:channelid (ຈໍາເປັນ) ID ຊ່ອງ
:ປະເພດ (ຈໍາເປັນ) link ຫຼື bio ຫຼື 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."
}

ピクセル

ລາຍການ Pixels

ຮັບ https://urlkai.com/api/pixels?limit=2&page=1

ເພື່ອຈະໄດ້ຮັບໂປຣແກຣມ pixels ຂອງເຈົ້າຜ່ານ 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"
            }
        ]
    }
}

ສ້າງ Pixel

ໂພສ https://urlkai.com/api/pixel/add

pixel ສາມາດສ້າງໄດ້ໂດຍໃຊ້ຈຸດສຸດທ້າຍນີ້. ທ່ານຕ້ອງສົ່ງປະເພດ pixel ແລະ tag.

พารามิเตอร์ ຄໍາອະທິບາຍ
ປະເພດ (ຈໍາເປັນ) gtmpixel | gapixel | fbpixel | AdWordsPixel | linkedinpixel | Twitterpixel | adrollpixel | quorapixel | pinterest | ບິງ | Snapchat | reddit | tiktok
ຊື່ (ຈໍາເປັນ) ຊື່ສະເພາະສໍາລັບ pixel ຂອງເຈົ້າ
ແທັກ (ຈໍາເປັນ) ແທັກສໍາລັບ pixel
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

ເພື່ອປັບປຸງ pixel, ທ່ານຕ້ອງສົ່ງຂໍ້ມູນທີ່ຖືກຕ້ອງໃນ JSON ຜ່ານຄໍາຮ້ອງຂໍ PUT. ຂໍ້ມູນຕ້ອງຖືກສົ່ງເປັນເນື້ອໃນຂອງຄໍາຮ້ອງຂໍຂອງທ່ານດັ່ງທີ່ສະແດງໄວ້ທາງລຸ່ມນີ້. ຕົວຢ່າງທາງລຸ່ມນີ້ສະແດງໃຫ້ເຫັນຕົວເລກທັງຫມົດທີ່ທ່ານສາມາດສົ່ງໄດ້ແຕ່ທ່ານບໍ່ຈໍາເປັນຕ້ອງສົ່ງທັງຫມົດ (ເບິ່ງຕາຕະລາງສໍາລັບຂໍ້ມູນເພີ່ມເຕີມ).

พารามิเตอร์ ຄໍາອະທິບາຍ
ຊື່ (ເລືອກ) ຊື່ສະເພາະສໍາລັບ pixel ຂອງເຈົ້າ
ແທັກ (ຈໍາເປັນ) ແທັກສໍາລັບ pixel
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."
}

ລຶບ Pixel

ລຶບ https://urlkai.com/api/pixel/:id/delete

ເພື່ອລຶບ pixel, ທ່ານຕ້ອງສົ່ງຄໍາຮ້ອງຂໍ 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."
}