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 مع كل طلب (انظر المثال الكامل أدناه). إذا لم يتم إرسال مفتاح واجهة برمجة التطبيقات أو انتهت صلاحيته، سيظهر خطأ. يرجى التأكد من الحفاظ على سرية مفتاح واجهة برمجة التطبيقات لمنع إساءة الاستخدام.

المصادقة

للمصادقة مع نظام واجهة برمجة التطبيقات، تحتاج إلى إرسال مفتاح واجهة برمجة التطبيقات الخاص بك كرمز تفويض مع كل طلب. يمكنك الاطلاع على نموذج الكود أدناه.

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

حد المعدل

تحتوي واجهة برمجة التطبيقات (API) الخاصة بنا على محدد معدل للحماية من الارتفاع المفاجئ في الطلبات لزيادة استقرارها. يبلغ الحد الأقصى لمحدد المعدل لدينا حاليًا {س} من الطلبات لكل {ص} دقيقة. يُرجى ملاحظة أن السعر قد يتغير وفقًا للخطة التي تم الاشتراك بها.

سيتم إرسال عدة رؤوس إلى جانب الاستجابة ويمكن فحصها لتحديد المعلومات المختلفة حول الطلب.

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

معالجة الاستجابة

يتم إرجاع جميع استجابات واجهة برمجة التطبيقات بتنسيق JSON افتراضيًا. لتحويلها إلى بيانات قابلة للاستخدام، يجب استخدام الدالة المناسبة وفقًا للغة. في لغة PHP، يمكن استخدام الدالة json_decode() لتحويل البيانات إلى كائن (افتراضي) أو مصفوفة (اضبط المعلمة الثانية على صواب). من المهم جدًا التحقق من مفتاح الخطأ لأنه يوفر معلومات حول ما إذا كان هناك خطأ أم لا. يمكنك أيضًا التحقق من رمز الرأس.

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

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 (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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\/dgsKj",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/konnect.ing\/AzQEh",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/konnect.ing\/yFTKY",
            "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 (اختياري) اسم مستعار مخصص بدلاً من الاسم المستعار العشوائي.
domain (اختياري) نطاق مخصص
password (اختياري) الحماية بكلمة مرور
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\/kPzQQ"
}

الحساب

الحصول على حساب

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

الحملات

قائمة الحملات

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

للحصول على حملاتك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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

يمكن إضافة حملة باستخدام نقطة النهاية هذه.

المعلمة الوصف
name (اختياري) اسم الحملة
slug (اختياري) السبيكة الدوارة
public (اختياري) الوصول
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

يمكن تعيين رابط قصير لحملة باستخدام نقطة النهاية هذه. تتطلب نقطة النهاية معرف الحملة ومعرف الرابط القصير.

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

لتحديث حملة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كهيئة خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها جميعًا (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
name (مطلوب) اسم الحملة
slug (اختياري) السبيكة الدوارة
public (اختياري) الوصول
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 https://konnect.ing/api/campaign/:id/delete

لحذف حملة، تحتاج إلى إرسال طلب حذف.

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

القنوات

قائمة القنوات

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

للحصول على قنواتك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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
            }
        ]
    }
}

قائمة عناصر القناة

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

للحصول على عناصر في قنوات محددة عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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

يمكن إضافة قناة باستخدام نقطة النهاية هذه.

المعلمة الوصف
name (مطلوب) اسم القناة
description (اختياري) وصف القناة
color (اختياري) لون شارة القناة (HEX)
starred (اختياري) قم بتمييز القناة بنجمة أو لا (صواب أو خطأ)
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
}

تعيين عنصر إلى قناة

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

يمكن تعيين عنصر إلى أي قناة عن طريق إرسال طلب بمعرف القناة ونوع العنصر (روابط أو سيرة ذاتية أو qr) ومعرف العنصر.

المعلمة الوصف
:channelid (مطلوب) معرف القناة
:type (مطلوب) الروابط أو السيرة الذاتية أو QR
:itemid (مطلوب) معرّف السلعة
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

لتحديث قناة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كجسم خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها كلها (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
name (اختياري) اسم القناة
description (اختياري) وصف القناة
color (اختياري) لون شارة القناة (HEX)
starred (اختياري) قم بتمييز القناة بنجمة أو لا (صواب أو خطأ)
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 https://konnect.ing/api/channel/:id/delete

لحذف قناة، تحتاج إلى إرسال طلب حذف. سيتم إلغاء تعيين جميع العناصر أيضًا.

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

النطاقات ذات العلامات التجارية

قائمة النطاقات ذات العلامات التجارية

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

للحصول على النطاقات التي تحمل علامتك التجارية عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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"
            }
        ]
    }
}

إنشاء نطاق ذي علامة تجارية

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

يمكن إضافة نطاق باستخدام نقطة النهاية هذه. يرجى التأكد من توجيه المجال بشكل صحيح إلى خادمنا.

المعلمة الوصف
domain (مطلوب) نطاق العلامة التجارية بما في ذلك http أو https
redirectroot (اختياري) إعادة توجيه الجذر عند زيارة شخص ما لنطاقك
redirect404 (اختياري) إعادة توجيه 404 مخصص 404
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

لتحديث مجال ذي علامة تجارية، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كجسم خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها جميعًا (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
redirectroot (اختياري) إعادة توجيه الجذر عند زيارة شخص ما لنطاقك
redirect404 (اختياري) إعادة توجيه 404 مخصص 404
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 https://konnect.ing/api/domain/:id/delete

لحذف نطاق، تحتاج إلى إرسال طلب حذف.

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

تراكبات CTA

قائمة تراكبات CTA

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

للحصول على تراكبات cta عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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"
            }
        ]
    }
}

رموز الاستجابة السريعة

قائمة رموز الاستجابة السريعة

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

للحصول على رموز QR الخاصة بك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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 Code واحد

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

للحصول على تفاصيل رمز 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
        }
    }
}

إنشاء رمز الاستجابة السريعة

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

لإنشاء رمز الاستجابة السريعة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب POST. يجب إرسال البيانات كجسم خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها جميعًا (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
type (مطلوب) رسالة نصية | بطاقة vcard | رابط | بريد إلكتروني | هاتف | رسالة قصيرة | واي فاي
data (مطلوب) البيانات المراد تضمينها داخل رمز الاستجابة السريعة. يمكن أن تكون البيانات سلسلة أو مصفوفة بناءً على النوع
background (اختياري) لون RGB على سبيل المثال rgb(255,255,255)
foreground (اختياري) لون RGB مثل rgb(0,0,0)
logo (اختياري) المسار إلى الشعار إما png أو jpg
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"
}

تحديث رمز الاستجابة السريعة

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

لتحديث رمز الاستجابة السريعة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كجسم خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها جميعًا (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
data (مطلوب) البيانات المراد تضمينها داخل رمز الاستجابة السريعة. يمكن أن تكون البيانات سلسلة أو مصفوفة بناءً على النوع
background (اختياري) لون RGB على سبيل المثال rgb(255,255,255)
foreground (اختياري) لون RGB مثل rgb(0,0,0)
logo (اختياري) المسار إلى الشعار إما png أو 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."
}

حذف رمز الاستجابة السريعة

DELETE https://konnect.ing/api/qr/:id/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/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 (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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"
            }
        ]
    }
}

وحدات البكسل

قائمة البيكسلات

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

للحصول على رموز البكسل الخاصة بك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضًا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
limit (اختياري) نتيجة بيانات الصفحة الواحدة
page (اختياري) طلب الصفحة الحالية
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"
            }
        ]
    }
}

إنشاء بكسل

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

يمكن إنشاء بكسل باستخدام نقطة النهاية هذه. تحتاج إلى إرسال نوع البكسل والعلامة.

المعلمة الوصف
type (required) gtmpixel | gapixel | fbpixel | adwordspixel | linkedinpixel | twitterpixel | adrollpixel | quorapixel | pinterest | bing | snapchat | reddit | tiktok
name (مطلوب) اسم مخصص للبكسل الخاص بك
tag (مطلوب) العلامة الخاصة بالبكسل
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

لتحديث بكسل، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كجسم خام لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكنك لست مطالبًا بإرسالها جميعًا (انظر الجدول لمزيد من المعلومات).

المعلمة الوصف
name (اختياري) اسم مخصص للبكسل الخاص بك
tag (مطلوب) العلامة الخاصة بالبكسل
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 https://konnect.ing/api/pixel/:id/delete

لحذف بكسل، تحتاج إلى إرسال طلب حذف.

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