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.

Getting Started

درخواستوں کو نظام کے ذریعے عمل کرانے کے لیے API کلید درکار ہوتی ہے۔ ایک بار جب صارف رجسٹر ہو جاتا ہے، تو اس صارف کے لیے خود بخود API کلید تیار کر دی جاتی ہے۔ API کلید ہر درخواست کے ساتھ بھیجی جانی چاہیے (ذیل میں مکمل مثال دیکھیں)۔ اگر API کلید نہیں بھیجی جاتی یا اس کی میعاد ختم ہو چکی ہے، تو ایک خرابی ہوگی۔ براہ کرم یقینی بنائیں کہ غلط استعمال سے بچنے کے لیے آپ اپنی API کلید کو خفیہ رکھیں۔

Authentication

API نظام کے ساتھ تصدیق کے لیے، آپ کو ہر درخواست کے ساتھ اپنی API کلید کو ایک تصدیقی ٹوکن کے طور پر بھیجنے کی ضرورت ہے۔ آپ ذیل میں نمونہ کوڈ دیکھ سکتے ہیں۔

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

Rate Limit

ہمارے پاس درخواستوں میں اضافے کے خلاف تحفظ کے لیے ایک شرح کی حد ہے تاکہ اس کی استحکام کو زیادہ سے زیادہ کیا جا سکے۔ ہماری شرح کی حد فی حال 30 درخواستیں فی 1 منٹ پر محدود ہے۔ Please note that the rate might change according to the subscribed plan.

جواب کے ساتھ ساتھ متعدد ہیڈرز بھیجے جائیں گے، جن کا معائنہ کرکے درخواست کے بارے میں مختلف معلومات کا تعین کیا جا سکتا ہے۔

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

Response Handling

تمام API جوابات پہلے سے طے شدہ طور پر JSON فارمیٹ میں واپس کیے جاتے ہیں۔ قابل استعمال ڈیٹا میں تبدیل کرنے کے لیے، زبان کے مطابق مناسب فنکشن کا استعمال کرنے کی ضرورت ہوگی۔ PHP میں، فنکشن json_decode() کا استعمال ڈیٹا کو ایک آبجیکٹ (پہلے سے طے شدہ) یا ایک صف (دوسرے پیرامیٹر کو true پر سیٹ کریں) میں تبدیل کرنے کے لیے کیا جا سکتا ہے۔ یہ بہت اہم ہے کہ خرابی کی کلید کی پڑتال کی جائے کیونکہ یہ یہ معلومات فراہم کرتی ہے کہ کیا کوئی خرابی ہوئی ہے یا نہیں۔ آپ ہیڈر کوڈ بھی چیک کر سکتے ہیں۔

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

CTA اوورلےز

List CTA Overlays

GET https://konnect.ing/api/overlay?limit=2&page=1

To get cta overlays via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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"
            }
        ]
    }
}

List Files

GET https://konnect.ing/api/files?limit=2&page=1

Get all of your files. You can also search by name.

پیرامیٹر تفصیل
name (optional) Search for a file by name
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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:\/\/konnect.ing\/nMFzl",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/konnect.ing\/WCcDr",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/konnect.ing\/eaztP",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Upload a file

POST https://konnect.ing/api/files/upload/:filename?name=My+File

Upload a file by sending the binary data as the post body. You need to send the file name including the extension instead of :filename in the url (e.g. brandkit.zip). You can set options by sending the following parameters.

پیرامیٹر تفصیل
name (optional) File name
custom (optional) Custom alias instead of random alias.
domain (optional) Custom Domain
password (optional) Password protection
expiry (optional) Expiration for the download example 2021-09-28
maxdownloads (optional) Maximum number of downloads
curl --location --request POST 'https://konnect.ing/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:\/\/konnect.ing\/auWjI"
}

QR کوڈز

List QR codes

GET https://konnect.ing/api/qr?limit=2&page=1

اپنے QR کوڈز کو API کے ذریعے حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کا استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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:\/\/konnect.ing\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/konnect.ing\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

ایک QR کوڈ حاصل کریں

GET https://konnect.ing/api/qr/:id

API کے ذریعے ایک QR کوڈ کی تفصیلات حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کا استعمال کر سکتے ہیں۔

curl --location --request GET 'https://konnect.ing/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

سرور جواب

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/konnect.ing\/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 کوڈ بنائیں

POST https://konnect.ing/api/qr/add

To create a QR Code, you need to send a valid data in JSON via a POST request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

پیرامیٹر تفصیل
type (required) text | vcard | link | email | phone | sms | wifi
data (required) Data to be embedded inside the QR code. The data can be string or array depending on the type
background (optional) RGB color e.g. rgb(255,255,255)
foreground (optional) RGB color e.g. rgb(0,0,0)
logo (optional) Path to the logo either png or jpg
name (optional) QR Code name
curl --location --request POST 'https://konnect.ing/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:\/\/konnect.ing\/qr\/a58f79"
}

Update QR Code

PUT https://konnect.ing/api/qr/:id/update

ایک QR کوڈ کی تازہ کاری کے لیے، آپ کو JSON کے ذریعے ایک درست ڈیٹا کو PUT درخواست کے ساتھ بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام باڈی کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ ذیل کی مثال میں تمام پیرامیٹرز دکھائے گئے ہیں جو آپ بھیج سکتے ہیں لیکن آپ کو سب کچھ بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
data (required) Data to be embedded inside the QR code. The data can be string or array depending on the type
background (optional) RGB color e.g. rgb(255,255,255)
foreground (optional) RGB color e.g. rgb(0,0,0)
logo (optional) Path to the logo either png or jpg
curl --location --request PUT 'https://konnect.ing/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 کوڈ حذف کریں

DELETE https://konnect.ing/api/qr/:id/delete

ایک QR کوڈ کو حذف کرنے کے لیے، آپ کو ایک DELETE درخواست بھیجنی ہوگی۔

curl --location --request DELETE 'https://konnect.ing/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

سرور جواب

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

اکاؤنٹ

اکاؤنٹ حاصل کریں

GET https://konnect.ing/api/account

اکاؤنٹ کی معلومات حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ پر ایک درخواست بھیج سکتے ہیں اور یہ اکاؤنٹ کے بارے میں ڈیٹا واپس کرے گا۔

curl --location --request GET 'https://konnect.ing/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"
    }
}

اکاؤنٹ کی تازہ کاری کریں

PUT https://konnect.ing/api/account/update

اکاؤنٹ کی معلومات کی تازہ کاری کے لیے، آپ اس اینڈ پوائنٹ پر ایک درخواست بھیج سکتے ہیں اور یہ اکاؤنٹ کے ڈیٹا کی تازہ کاری کرے گا۔

curl --location --request PUT 'https://konnect.ing/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."
}

برانڈ ڈومینز

List Branded Domains

GET https://konnect.ing/api/domains?limit=2&page=1

To get your branded domains via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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"
            }
        ]
    }
}

Create a Branded Domain

POST https://konnect.ing/api/domain/add

A domain can be added using this endpoint. Please make sure the domain is correctly pointed to our server.

پیرامیٹر تفصیل
domain (required) Branded domain including http or https
redirectroot (optional) Root redirect when someone visits your domain
redirect404 (optional) Custom 404 redirect
curl --location --request POST 'https://konnect.ing/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
}

ڈومین کی تازہ کاری کریں

PUT https://konnect.ing/api/domain/:id/update

To update a branded domain, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

پیرامیٹر تفصیل
redirectroot (optional) Root redirect when someone visits your domain
redirect404 (optional) Custom 404 redirect
curl --location --request PUT 'https://konnect.ing/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."
}

Delete Domain

DELETE https://konnect.ing/api/domain/:id/delete

To delete a domain, you need to send a DELETE request.

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

سرور جواب

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

حسب ضرورت اسپلیش

List Custom Splash

GET https://konnect.ing/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).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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"
            }
        ]
    }
}

مہمات

List Campaigns

GET https://konnect.ing/api/campaigns?limit=2&page=1

To get your campaigns via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

سرور جواب

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

ایک مہم بنائیں

POST https://konnect.ing/api/campaign/add

A campaign can be added using this endpoint.

پیرامیٹر تفصیل
name (optional) Campaign name
slug (optional) Rotator Slug
public (optional) Access
curl --location --request POST 'https://konnect.ing/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

سرور جواب

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
POST https://konnect.ing/api/campaign/:campaignid/assign/:linkid

A short link can be assigned to a campaign using this endpoint. The endpoint requires the campaign ID and the short link ID.

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

سرور جواب

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

مہم کی تازہ کاری کریں

PUT https://konnect.ing/api/campaign/:id/update

To update a campaign, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

پیرامیٹر تفصیل
name (required) Campaign name
slug (optional) Rotator Slug
public (optional) Access
curl --location --request PUT 'https://konnect.ing/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"
}

Delete Campaign

DELETE https://konnect.ing/api/campaign/:id/delete

To delete a campaign, you need to send a DELETE request.

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

سرور جواب

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

پکسلز

List Pixels

GET https://konnect.ing/api/pixels?limit=2&page=1

To get your pixels codes via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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"
            }
        ]
    }
}

Create a Pixel

POST https://konnect.ing/api/pixel/add

A pixel can be created using this endpoint. You need to send the pixel type and the tag.

پیرامیٹر تفصیل
type (required) gtmpixel | gapixel | fbpixel | adwordspixel | linkedinpixel | twitterpixel | adrollpixel | quorapixel | pinterest | bing | snapchat | reddit | tiktok
name (required) Custom name for your pixel
tag (required) The tag for the pixel
curl --location --request POST 'https://konnect.ing/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
}

پکسل کی تازہ کاری کریں

PUT https://konnect.ing/api/pixel/:id/update

To update a pixel, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

پیرامیٹر تفصیل
name (optional) Custom name for your pixel
tag (required) The tag for the pixel
curl --location --request PUT 'https://konnect.ing/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."
}

Delete Pixel

DELETE https://konnect.ing/api/pixel/:id/delete

To delete a pixel, you need to send a DELETE request.

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

سرور جواب

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

چینلز

List Channels

GET https://konnect.ing/api/channels?limit=2&page=1

To get your channels via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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
            }
        ]
    }
}

List Channel Items

GET https://konnect.ing/api/channel/:id?limit=1&page=1

To get items in a select channels via the API, you can use this endpoint. You can also filter data (See table for more info).

پیرامیٹر تفصیل
limit (optional) Per page data result
page (optional) Current page request
curl --location --request GET 'https://konnect.ing/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:\/\/konnect.ing\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/konnect.ing\/mybio",
                "link": "https:\/\/konnect.ing\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

ایک چینل بنائیں

POST https://konnect.ing/api/channel/add

A channel can be added using this endpoint.

پیرامیٹر تفصیل
name (required) Channel name
description (optional) Channel description
color (optional) Channel badge color (HEX)
starred (optional) Star the channel or not (true or false)
curl --location --request POST 'https://konnect.ing/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
}

Assign an Item to a Channel

POST https://konnect.ing/api/channel/:channelid/assign/:type/:itemid

An item can be assigned to any channel by sending a request with the channel id, item type (links, bio or qr) and item id.

پیرامیٹر تفصیل
:channelid (required) Channel ID
:type (required) links or bio or qr
:itemid (required) Item ID
curl --location --request POST 'https://konnect.ing/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

سرور جواب

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

چینل کی تازہ کاری کریں

PUT https://konnect.ing/api/channel/:id/update

To update a channel, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

پیرامیٹر تفصیل
name (optional) Channel name
description (optional) Channel description
color (optional) Channel badge color (HEX)
starred (optional) Star the channel or not (true or false)
curl --location --request PUT 'https://konnect.ing/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."
}

Delete Channel

DELETE https://konnect.ing/api/channel/:id/delete

To delete a channel, you need to send a DELETE request. All items will be unassigned as well.

curl --location --request DELETE 'https://konnect.ing/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

سرور جواب

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