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 কীটি প্রেরণ করতে হবে। আপনি নীচে নমুনা কোড দেখতে পারেন।

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

রেট লিমিট

আমাদের এপিআইয়ের স্থিতিশীলতা বাড়ানোর জন্য অনুরোধের স্পাইক থেকে রক্ষা করার জন্য একটি রেট লিমিটার রয়েছে। আমাদের রেট লিমিটার বর্তমানে প্রতি 1 মিনিটে 30 টি অনুরোধে সীমাবদ্ধ করা হয়েছে। দয়া করে মনে রাখবেন যে সাবস্ক্রাইব করা পরিকল্পনা অনুযায়ী হার পরিবর্তন হতে পারে।

প্রতিক্রিয়ার পাশাপাশি বেশ কয়েকটি শিরোনাম প্রেরণ করা হবে এবং অনুরোধ সম্পর্কে বিভিন্ন তথ্য নির্ধারণের জন্য এগুলি পরীক্ষা করা যেতে পারে।

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

প্রতিক্রিয়া হ্যান্ডলিং

সমস্ত এপিআই প্রতিক্রিয়া ডিফল্টরূপে জেএসওএন ফর্ম্যাটে ফেরত দেওয়া হয়। এটিকে ব্যবহারযোগ্য ডেটাতে রূপান্তর করতে, উপযুক্ত ফাংশনটি ভাষা অনুসারে ব্যবহার করতে হবে। পিএইচপিতে, ফাংশন 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/domains?limit=2&page=1

এপিআইয়ের মাধ্যমে আপনার ব্র্যান্ডযুক্ত ডোমেনগুলি পেতে, আপনি এই এন্ডপয়েন্টটি ব্যবহার করতে পারেন। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

একটি ব্র্যান্ডেড ডোমেন তৈরি করুন

পোস্ট https://urlkai.com/api/domain/add

এই এন্ডপয়েন্ট ব্যবহার করে একটি ডোমেইন যুক্ত করা যায়। অনুগ্রহ করে নিশ্চিত করুন যে ডোমেনটি সঠিকভাবে আমাদের সার্ভারে নির্দেশিত হয়েছে।

প্যারামিটার বর্ণনা
ডোমেন (আবশ্যক) এইচটিটিপি বা https সহ ব্র্যান্ডেড ডোমেন
পুনঃনির্দেশ। (ঐচ্ছিক) যখন কেউ আপনার ডোমেন পরিদর্শন করে তখন রুট পুনঃনির্দেশ
পুনর্নির্দেশ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

একটি ব্র্যান্ডেড ডোমেন আপডেট করতে, আপনাকে PUT অনুরোধের মাধ্যমে JSON এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
পুনঃনির্দেশ। (ঐচ্ছিক) যখন কেউ আপনার ডোমেন পরিদর্শন করে তখন রুট পুনঃনির্দেশ
পুনর্নির্দেশ404 (ঐচ্ছিক) কাস্টম 404 পুনর্নির্দেশ
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

সার্ভারের প্রতিক্রিয়া

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

ডোমেন মুছুন

বিলোপ https://urlkai.com/api/domain/:id/delete

কোনও ডোমেন মুছতে, আপনাকে একটি মুছুনের অনুরোধ পাঠাতে হবে।

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

সার্ভারের প্রতিক্রিয়া

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

সিটিএ ওভারলে

সিটিএ ওভারলে তালিকাভুক্ত করুন

পেয়ে যান https://urlkai.com/api/overlay?limit=2&page=1

এপিআইয়ের মাধ্যমে সিটিএ ওভারলে পেতে, তুমি এই এন্ডপয়েন্টটি ব্যবহার করতে পারো। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

প্রচারণা

তালিকা প্রচারণা

পেয়ে যান https://urlkai.com/api/campaigns?limit=2&page=1

এপিআইয়ের মাধ্যমে আপনার প্রচারগুলি পেতে, আপনি এই এন্ডপয়েন্টটি ব্যবহার করতে পারেন। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

একটি প্রচারাভিযান তৈরি করুন

পোস্ট https://urlkai.com/api/campaign/add

এই এন্ডপয়েন্ট ব্যবহার করে একটি ক্যাম্পেইন যোগ করা যেতে পারে।

প্যারামিটার বর্ণনা
নাম (ঐচ্ছিক) ক্যাম্পেইনের নাম
স্লাগ (ঐচ্ছিক) ঘূর্ণনকারী স্লাগ
সর্বজনীন (ঐচ্ছিক) এক্সেস
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

সার্ভারের প্রতিক্রিয়া

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
পোস্ট https://urlkai.com/api/campaign/:campaignid/assign/:linkid

এই এন্ডপয়েন্ট ব্যবহার করে একটি প্রচারাভিযানের জন্য একটি সংক্ষিপ্ত লিঙ্ক বরাদ্দ করা যেতে পারে। এন্ডপয়েন্টের জন্য ক্যাম্পেইন আইডি এবং শর্ট লিংক আইডি প্রয়োজন।

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

সার্ভারের প্রতিক্রিয়া

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

ক্যাম্পেইন আপডেট করুন

পুট https://urlkai.com/api/campaign/:id/update

একটি প্রচারাভিযান আপডেট করতে, আপনাকে PUT অনুরোধের মাধ্যমে JSON -এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
নাম (আবশ্যক) ক্যাম্পেইনের নাম
স্লাগ (ঐচ্ছিক) ঘূর্ণনকারী স্লাগ
সর্বজনীন (ঐচ্ছিক) এক্সেস
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

সার্ভারের প্রতিক্রিয়া

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

প্রচারাভিযান মুছে ফেলুন

বিলোপ https://urlkai.com/api/campaign/:id/delete

একটি প্রচারাভিযান মুছতে, আপনাকে একটি মুছুনের অনুরোধ পাঠাতে হবে।

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

সার্ভারের প্রতিক্রিয়া

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

চ্যানেল

তালিকা চ্যানেল

পেয়ে যান https://urlkai.com/api/channels?limit=2&page=1

এপিআইয়ের মাধ্যমে তোমার চ্যানেলগুলি পেতে, তুমি এই এন্ডপয়েন্টটি ব্যবহার করতে পারো। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

চ্যানেল আইটেমগুলির তালিকা করুন

পেয়ে যান https://urlkai.com/api/channel/:id?limit=1&page=1

এপিআইয়ের মাধ্যমে একটি নির্বাচিত চ্যানেলগুলিতে আইটেমগুলি পেতে, তুমি এই এন্ডপয়েন্টটি ব্যবহার করতে পারো। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

একটি চ্যানেল তৈরি করুন

পোস্ট https://urlkai.com/api/channel/add

এই এন্ডপয়েন্টটি ব্যবহার করে একটি চ্যানেল যুক্ত করা যেতে পারে।

প্যারামিটার বর্ণনা
নাম (আবশ্যক) চ্যানেলের নাম
বর্ণনা (ঐচ্ছিক) চ্যানেলের বর্ণনা
রঙ (ঐচ্ছিক) চ্যানেল ব্যাজের রঙ (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
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

একটি চ্যানেল আপডেট করতে, আপনাকে PUT অনুরোধের মাধ্যমে JSON এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
নাম (ঐচ্ছিক) চ্যানেলের নাম
বর্ণনা (ঐচ্ছিক) চ্যানেলের বর্ণনা
রঙ (ঐচ্ছিক) চ্যানেল ব্যাজের রঙ (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

কোনও চ্যানেল মুছতে, আপনাকে একটি মুছুনের অনুরোধ পাঠাতে হবে। সমস্ত আইটেম পাশাপাশি অনির্ধারিত থাকবে।

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

একটি ফাইল আপলোড করুন

পোস্ট https://urlkai.com/api/files/upload/:filename?name=My+File

পোস্ট বডি হিসাবে বাইনারি ডেটা প্রেরণ করে একটি ফাইল আপলোড করুন। আপনাকে ইউআরএল-এ :ফাইলের নামের পরিবর্তে এক্সটেনশন সহ ফাইলের নাম প্রেরণ করতে হবে (যেমন 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\/iiPjB"
}

পিক্সেল

তালিকা পিক্সেল

পেয়ে যান https://urlkai.com/api/pixels?limit=2&page=1

এপিআইয়ের মাধ্যমে আপনার পিক্সেল কোডগুলি পেতে, আপনি এই এন্ডপয়েন্টটি ব্যবহার করতে পারেন। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

সার্ভারের প্রতিক্রিয়া

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

একটি পিক্সেল তৈরি করুন

পোস্ট https://urlkai.com/api/pixel/add

এই এন্ডপয়েন্ট ব্যবহার করে একটি পিক্সেল তৈরি করা যেতে পারে। আপনাকে পিক্সেল টাইপ এবং ট্যাগ পাঠাতে হবে।

প্যারামিটার বর্ণনা
টাইপ (আবশ্যক) জিটিএমপিক্সেল | গ্যাপিক্সেল | fbpixel | অ্যাডওয়ার্ডসপিক্সেল | লিংকডইনপিক্সেল | টুইটার পিক্সেল | অ্যাড্রোলপিক্সেল | Quorapixel | পিন্টারেস্ট | বিং | স্ন্যাপচ্যাট | রেডিট | TikTok
নাম (আবশ্যক) আপনার পিক্সেলের জন্য কাস্টম নাম
ট্যাগ (আবশ্যক) পিক্সেলের জন্য ট্যাগ
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

একটি পিক্সেল আপডেট করতে, আপনাকে PUT অনুরোধের মাধ্যমে JSON এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
নাম (ঐচ্ছিক) আপনার পিক্সেলের জন্য কাস্টম নাম
ট্যাগ (আবশ্যক) পিক্সেলের জন্য ট্যাগ
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

সার্ভারের প্রতিক্রিয়া

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

পিক্সেল মুছে ফেলুন

বিলোপ https://urlkai.com/api/pixel/:id/delete

একটি পিক্সেল মুছতে, আপনাকে একটি মুছুন অনুরোধ পাঠাতে হবে।

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

সার্ভারের প্রতিক্রিয়া

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

কিউআর কোড

QR কোডগুলি তালিকাভুক্ত করুন

পেয়ে যান https://urlkai.com/api/qr?limit=2&page=1

এপিআইয়ের মাধ্যমে আপনার QR কোডগুলি পেতে, আপনি এই এন্ডপয়েন্টটি ব্যবহার করতে পারেন। আপনি ডেটা ফিল্টারও করতে পারেন (আরও তথ্যের জন্য সারণী দেখুন)।

প্যারামিটার বর্ণনা
সীমা (ঐচ্ছিক) প্রতি পৃষ্ঠার তথ্যের ফলাফল
পৃষ্ঠা (ঐচ্ছিক) বর্তমান পাতার অনুরোধ
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

এপিআইয়ের মাধ্যমে একক কিউআর কোডের বিশদ পেতে, আপনি এই এন্ডপয়েন্টটি ব্যবহার করতে পারেন।

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 কোড তৈরি করতে, আপনাকে POST অনুরোধের মাধ্যমে JSON -এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
টাইপ (আবশ্যক) লেখা | ভিকার্ড | লিংক | ইমেইল | ফোন | এসএমএস | ওয়াইফাই
ডাটা (আবশ্যক) কিউআর কোডের ভিতরে ডেটা এম্বেড করতে হবে। ধরনের উপর নির্ভর করে ডেটা স্ট্রিং বা অ্যারে হতে পারে
প্রেক্ষাপট (ঐচ্ছিক) আরজিবি রঙ উদাঃ আরজিবি (255,255,255)
অগ্রভাগে (ঐচ্ছিক) RGB রঙ যেমন rgb(0,0,0)
লোগো (ঐচ্ছিক) পিএনজি বা জেপিজি লোগোতে যাওয়ার পথ
নাম (ঐচ্ছিক) 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 কোড আপডেট করতে, আপনাকে PUT অনুরোধের মাধ্যমে JSON-এ একটি বৈধ ডেটা পাঠাতে হবে। নীচে যেমন দেখানো হয়েছে সেভাবে ডেটা অবশ্যই আপনার অনুরোধের কাঁচা সংস্থা হিসাবে প্রেরণ করতে হবে। নীচের উদাহরণটি আপনি পাঠাতে পারেন এমন সমস্ত পরামিতি দেখায় তবে আপনাকে সমস্ত পাঠাতে হবে না (আরও তথ্যের জন্য টেবিলটি দেখুন)।

প্যারামিটার বর্ণনা
ডাটা (আবশ্যক) কিউআর কোডের ভিতরে ডেটা এম্বেড করতে হবে। ধরনের উপর নির্ভর করে ডেটা স্ট্রিং বা অ্যারে হতে পারে
প্রেক্ষাপট (ঐচ্ছিক) আরজিবি রঙ উদাঃ আরজিবি (255,255,255)
অগ্রভাগে (ঐচ্ছিক) RGB রঙ যেমন rgb(0,0,0)
লোগো (ঐচ্ছিক) পিএনজি বা জেপিজি লোগোতে যাওয়ার পথ
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 কোড মুছতে, আপনাকে একটি মুছুনের অনুরোধ পাঠাতে হবে।

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