مستندات واجهات برمجة تطبيقات QRTIGER
تقدم واجهة برمجة تطبيقات qr المخصصة الخاصة بنا حلاً احترافيًا للعلامات التجارية التي تحتاج إلى قوالب رمز الاستجابة السريعة مخصصة مع نظام تتبع البيانات أو رموز الاستجابة السريعة الديناميكية أو رموز الاستجابة السريعة مجمعة ولديها رموز الاستجابة السريعة مدمجة في CRM.
واجهة برمجة التطبيقات الخاصة بنا متاحة على "Mashape" لأي أسئلة أخرى ، يمكنك دائما "الاتصال بنا" يمكن استخدام واجهة برمجة التطبيقات الخاصة بنا في جميع أنحاء العالم ، إذا كنت بحاجة إلى رموز QR الخاصة بك المتاحة في الصين ، يرجى الاتصال بنا. يمكننا أيضا القيام برمز الاستجابة السريعة المخصص للمدفوعات عبر الهاتف المحمول.
qrId:
توثيق
تحقق من هذا الفيديو من يوتيوب عن كيفية استخدامه
إنشاء رمز الاستجابة السريعة
1.أول تسجيل دخول واحصل على مفتاح واجهة برمجة التطبيقات للحصول على إذن في تتبع البيانات --> إعداد الحساب --> مفتاح واجهة برمجة التطبيقات
أول تسجيل دخول واحصل على مفتاح واجهة برمجة التطبيقات للحصول على إذن في تتبع البيانات --> إعداد الحساب --> مفتاح واجهة برمجة التطبيقات
2.Add this API key in every req (GET/POST) as Authorization: Bearer مفتاح واجهة برمجة التطبيقات
Add this API key in every req (GET/POST) as Authorization: Bearer مفتاح واجهة برمجة التطبيقات
3. إنشاء رمز QR مخصص ثابت
| عنوان URL | /api/qr/static |
| طرق | POST |
| تفويض | Bearer API KEY |
| إجابة | Binary Image File (PNG, SVG) |
طلب المعلمة
| qrCategory | string | url | qrCategory تحديد نوع مختلف من رمز الاستجابة السريعة مثل url ، Vcard ، facebook ، إلخ. تحقق أدناه من جدول qrCategory. |
| text | String | https://qrcode-tiger.com | سيتم تضمين عنوان url الخاص بإعادة التوجيه المطلوب في رمز الاستجابة السريعة |
| size | number | 500 | حجم رمز الاستجابة السريعة |
| logo | url | null | أضف أي عنوان URL للشعار لتمكين الشعار في منتصف رمز الاستجابة السريعة |
| colorDark | string | #5e0bf0 | لون أنماط رمز الاستجابة السريعة |
| backgroundColor | String | #ffffff | لون خلفية QR. (ملاحظة: اختر دائمًا لونًا ساطعًا للحصول على QR قابل للمسح الضوئي بالكامل) |
| gradient | Boolean | false | تعيين "true" لتمكين اللون المتدرج |
| grdType | Number | 0 (Left-to-Right) | تحقق من الجدول أدناه للحصول على grdType |
| color01 | String | #5e0bf0 | لون التدرج 1 لأنماط رمز الاستجابة السريعة |
| color02 | String | #f30505 | لون التدرج 2 لأنماط رمز الاستجابة السريعة |
| eye_color | Boolean | false | تعيين "true" لتغيير لون العين |
| eye_color01 | String | #5e0bf0 | لون العين الخارجية |
| eye_color02 | String | #f30505 | لون العين الداخلية |
| eye_outer | String | eyeOuter0 | تصميم مختلف للعين الخارجية ، تحقق من الجدول أدناه لجميع أنماط التصميم |
| eye_inner | String | eyeInner0 | تصميم مختلف للعين الداخلية ، تحقق من الجدول أدناه لجميع أنماط التصميم |
| qrData | String | pattern0 | تصميم مختلف لأنماط بيانات رمز الاستجابة السريعة ، تحقق من الجدول أدناه لمعرفة جميع أنماط التصميم |
| qrFormat | String | png | تنزيل نوع ملف الصورة الثنائية "png" أو "svg" |
| transparentBkg | Boolean | false | إذا تم تمكينه، سيكون لرمز الاستجابة السريعة خلفية شفافة |
| frame | Number | null | في حالة التمكين ، سيحتوي QR على إطار. تحقق من الجدول أدناه للحصول على تصاميم الإطار |
| frameColor | String | null | تغير لون الإطار لون نص الإطار |
| frameText | String | SCAN ME | يظهر نص الإطار فوق إطار QR |
مثال
| عنوان URL | /api/qr/static |
| طرق | POST |
| معامل | {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "scan_me.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://qrcode-tiger.com"
} |
| إجابة | {
"data": "base 64 QR image data",
"url": "1601477992984.png"
} |
4. احصل على قائمة بجميع عمليات QR لفئات QR المختلفة
| عنوان URL | /api/campaign/ |
| طرق | GET |
| تفويض | Bearer API KEY |
| إجابة | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
معلمات الاستعلام
| معامل | الافتراضي | وصف |
|---|---|---|
| page | 1 | رقم الصفحة |
| limit | 5 | رقم. العملية لكل صفحة |
| sort | 1 | فرز حسب التاريخ (1) أو الاسم (2) |
| category | url | الفئة تعرف انواع مختلفة من رموز الاستجابة السريعة مثل url ، Vcard ، facebook ، إلخ. تحقق أدناه جدول qrCategory. |
مثال
| عنوان URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
| طرق | GET |
| معامل | {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "scan_me.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://qrcode-tiger.com"
} |
| إجابة | {
"query": {
"limit": 1,
"page": 1,
"total": 146
},
"data": [
{
"scans": 0,
"_id": "5f6f373a33320a0ca52581b0",
"qrId": "HNXP",
"qrType": "qr2",
"qrCategory": "url",
"shortUrl": "https://qrcode-tiger.com/HNXP",
"redirectUrl": "https://www.qrcode-tiger.com/",
"murlData": [],
"qrName": "Campaign HNXP",
"qrImage": "HNXP.png",
"createdAt": "2020-09-26T12:42:34.070Z",
"updatedAt": "2020-09-26T12:42:34.070Z",
"user": null,
"id": "5f6f373a33320a0ca52581b0"
}
]
} |
5. قم بإنشاء رمز QR مرئي ديناميكي مخصص
| عنوان URL | /api/campaign/ |
| طرق | POST |
| تفويض | Bearer API KEY |
| إجابة | Binary Image File (PNG, SVG) |
معلمات الاستعلام
| معامل | نوع | الافتراضي | وصف | |
|---|---|---|---|---|
| qrUrl | String | https://qrcode-tiger.com | سيتم تضمين عنوان url الخاص بإعادة التوجيه المطلوب في رمز الاستجابة السريعة | |
| qrType | String | qr2 | يحدد qrType سلوك رمز الاستجابة السريعة مثل عنوان URL لإعادة التوجيه الفردي أو عنوان URL متعدد إعادة التوجيه ("qr2" أو "murl") | |
| qrCategory | String | url | qrCategory تحديد نوع مختلف من رمز الاستجابة السريعة مثل url ، Vcard ، facebook ، إلخ. تحقق أدناه من جدول qrCategory. | |
| qr: | JSON Object | صمم رمز الاستجابة السريعة الخاص بك مثل اللون وأنماط البيانات والعينين وما إلى ذلك داخل هذا الشيء | ||
| size | Number | 500 | حجم رمز الاستجابة السريعة | |
| logo | String (url) | null | أضف أي عنوان URL للشعار لتمكين الشعار في منتصف رمز الاستجابة السريعة | |
| colorDark | String | #5e0bf0 | لون أنماط رمز الاستجابة السريعة | |
| backgroundColor | String | #ffffff | لون خلفية QR. (ملاحظة: اختر دائمًا لونًا ساطعًا للحصول على QR قابل للمسح الضوئي بالكامل) | |
| gradient | Boolean | false | تعيين "true" لتمكين اللون المتدرج | |
| grdType | Number | 0 (Left-to-Right) | تحقق من الجدول أدناه للحصول على grdType | |
| color01 | String | #5e0bf0 | لون التدرج 1 لأنماط رمز الاستجابة السريعة | |
| color02 | String | #f30505 | لون التدرج 2 لأنماط رمز الاستجابة السريعة | |
| eye_color | Boolean | false | تعيين "true" لتغيير لون العين | |
| eye_color01 | String | #5e0bf0 | لون العين الخارجية | |
| eye_color02 | String | #f30505 | لون العين الداخلية | |
| eye_outer | String | eyeOuter0 | تصميم مختلف للعين الخارجية ، تحقق من الجدول أدناه لجميع أنماط التصميم | |
| eye_inner | String | eyeInner0 | تصميم مختلف للعين الداخلية ، تحقق من الجدول أدناه لجميع أنماط التصميم | |
| qrData | String | pattern0 | تصميم مختلف لأنماط بيانات رمز الاستجابة السريعة ، تحقق من الجدول أدناه لمعرفة جميع أنماط التصميم | |
| qrFormat | String | png | تنزيل نوع ملف الصورة الثنائية "png" أو "svg" | |
| transparentBkg | Boolean | false | إذا تم تمكينه، سيكون لرمز الاستجابة السريعة خلفية شفافة | |
| frame | Number | null | في حالة التمكين ، سيحتوي QR على إطار. تحقق من الجدول أدناه للحصول على تصاميم الإطار | |
| frameColor | String | null | تغير لون الإطار لون نص الإطار | |
| frameText | String | SCAN ME | يظهر نص الإطار فوق إطار QR |
مثال
| عنوان URL | /api/campaign |
| طرق | POST |
| Request Body | {
"qr": {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "1545827032075.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://www.qrcode-tiger.com.com/"
},
"murlData": [],
"qrUrl": "https://www.qrcode-tiger.com.com",
"qrType": "qr2",
"qrCategory": "url",
"qrId": "MP72"
} |
| Request Body | |
grdType (Default 0)
| معامل | نوع | قيمة | وصف |
|---|---|---|---|
| يسار يمين | String | linear | تدفق التدرج من اليسار إلى اليمين |
| أعلى وأسفل | String | upDown | تدفق التدرج من أعلى إلى أسفل |
| NW - SE | String | diagonal1 | تدفق التدرج قطريًا إلى الأسفل |
| جنوب غرب - شمال شرق | String | diagonal2 | تدفق متدرج قطريًا لأعلى |
| قطري | String | radial | تدفق متدرج شعاعي |
eye_outer (Default 0)
| معامل | نوع | قيمة | وصف |
|---|---|---|---|
| eye_outer | String | eyeOuter0 | |
| eyeOuter1 | |||
| eyeOuter2 | |||
| eyeOuter3 | |||
| eyeOuter4 | |||
| eyeOuter5 | |||
| eyeOuter6 | |||
| eyeOuter7 | |||
| eyeOuter8 | |||
| eyeOuter9 |
eye_inner
| معامل | نوع | قيمة | وصف |
|---|---|---|---|
| eye_inner | String | eyeInner0 | |
| eyeInner1 | |||
| eyeInner2 | |||
| eyeInner3 | |||
| eyeInner4 | |||
| eyeInner5 | |||
| eyeInner6 | |||
| eyeInner7 | |||
| eyeInner8 | |||
| eyeInner9 |
QrData
| معامل | نوع | قيمة | وصف |
|---|---|---|---|
| qrData | String | pattern0 | |
| pattern1 | |||
| pattern2 | |||
| pattern3 | |||
| pattern4 | |||
| pattern5 | |||
| pattern6 | |||
| pattern7 | |||
| pattern8 | |||
| pattern9 | |||
| pattern10 | |||
| pattern11 |
Frame (Default : null)
| معامل | نوع | قيمة | وصف |
|---|---|---|---|
| frame | Number | 1 | |
| 2 | |||
| 3 |
5. تتبع بيانات رمز الاستجابة السريعة الخاصة بك ، وعدد عمليات الفحص ، والبلد ، والمدينة ، ونوع الجهاز
| عنوان URL | /data/qrid?period=month&tz=Asia/Singapore |
| طرق | GET |
| تفويض | Bearer API KEY |
| إجابة | JSON object of track data |
طلب المعلمة
| معامل | نوع | وصف |
|---|---|---|
| qrId | params | معرف فريد لرمز الاستجابة السريعة |
| period | query | «اليوم» (بيانات اليوم الحالي) "الأسبوع" (بيانات الأسبوع الحالي) "الشهر" (بيانات الشهر الحالي) "أشهر" (بيانات العام الحالي) "السنة" (البيانات السنوية) |
| tz | query | افتراضي آسيا / سنغافورة |
| Response | {
"data": {
"campaign": {
"scanLoop": false,
"bulk": false,
"scans": 5,
"scanCounter": 0,
"_id": "5f297b7b88c80a7e70afbbc5",
"qrId": "BXFO",
"qrType": "qr2",
"qrCategory": "url",
"shortUrl": "https://qrcode-tiger.com/BXFO",
"redirectUrl": "http://hello.com.vn",
"murlData": [],
"qrName": "Campaign BXFO",
"qrImage": "BXFO.png",
"owner": "5a84402c08004f37a2b87831",
"scanData": [],
"createdAt": "2020-08-04T15:15:07.057Z",
"updatedAt": "2020-08-29T00:39:47.416Z",
"__v": 0,
"user": null,
"id": "5f297b7b88c80a7e70afbbc5"
},
"city": [
{
"_id": {
"city": "New York"
},
"count": 3
},
{
"_id": {
"city": "Ho Chi Minh City"
},
"count": 2
}
],
"data": [
{
"_id": {
"device": "iOS",
"loc": "VN",
"city": "Ho Chi Minh City"
},
"count": 1
},
{
"_id": {
"device": null,
"loc": "NY",
"city": "New York"
},
"count": 3
},
{
"_id": {
"device": null,
"loc": "VN",
"city": "Ho Chi Minh City"
},
"count": 1
}
],
"country": [
{
"_id": {
"loc": "VN"
},
"count": 2
},
{
"_id": {
"loc": "NY"
},
"count": 3
}
],
"device": [
{
"_id": {
"device": "Android"
},
"count": 4
},
{
"_id": {
"device": "iOS"
},
"count": 1
}
],
"scans": 5,
"unique": {
"label": [
{
"month": "Aug",
"year": 2020
}
],
"scans": [
2
]
},
"graph": {
"label": [
{
"month": "Aug",
"year": 2020
}
],
"scans": [
5
]
}
}
} |
6. قم بتحميل شعارك
| عنوان URL | /accounts/uploads/ |
| طرق | POST |
| Content-Type | multipart/form-data |
| Form-Field | File |
| Response | Image file url {“qrUrl”: 1526460566643.png} |