مستندات API
بارکدها
بارکدهای خود و تنظیمات صادرات آنها را مدیریت کنید.
احراز هویت
هر درخواست باید هدر Authorization را با توکن Bearer مطابق با کلید API مدیریت ارسال کند.
دریافت کلید API.
نقطه پایانی
GET https://rqrcode.com/api/barcodes/
مثال
curl --request GET \
--url 'https://rqrcode.com/api/barcodes/' \
--header 'Authorization: Bearer {api_key}'
پارامترها
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| page |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
شماره صفحهای که میخواهید نتایج آن را دریافت کنید. به طور پیشفرض 1 است. |
| results_per_page |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
چند نتیجه در هر صفحه میخواهید. مقادیر مجاز عبارتند از: 10، 25، 50، 100، 250، 500، 1000. به طور پیشفرض 25 است. |
نمونه پاسخ
{
"data": [
{
"id": 1,
"type": "C32",
"name": "نام مثال",
"value": "123456",
"barcode": "https://rqrcode.com/uploads/barcode/example.svg",
"settings": {
"foreground_color": "#000000",
"width_scale": 2,
"height": 50
},
"embedded_data": "123456",
"last_datetime": null,
"datetime": "2026-04-20 07:52:55"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/barcodes?page=1",
"last": "https://rqrcode.com/api/barcodes?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/barcodes?page=1"
}
}
نقطه پایانی
GET https://rqrcode.com/api/barcodes/{barcode_id}
مثال
curl --request GET \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
{
"data": {
"id": 1,
"type": "C32",
"name": "نام مثال",
"value": "123456",
"barcode": "https://rqrcode.com/uploads/barcode/example.svg",
"settings": {
"foreground_color": "#000000",
"width_scale": 2,
"height": 50
},
"embedded_data": "123456",
"last_datetime": null,
"datetime": "2026-04-20 07:52:55"
}
}
نقطه پایانی
POST https://rqrcode.com/api/barcodes
مثال
curl --request POST \
--url 'https://rqrcode.com/api/barcodes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=نیویورک' \
--form 'type=C32' \
--form 'value=123456'
پارامترها
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| project_id |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
— |
| name |
الزامی
ui.admin.api_docs.common.types.رشته
|
— |
| type |
الزامی
ui.admin.api_docs.common.types.رشته
|
مقادیر مجاز: C32, C39, C39+, C39E, C39E+, C93, S25, S25+, I25, I25+, ITF14, C128, C128A, C128B, C128C, EAN2, EAN5, EAN8, EAN13, UPCA, UPCE, MSI, MSI+, POSTNET, PLANET, TELEPENALPHA, TELEPENNUMERIC, RMS4CC, KIX, IMB, CODABAR, CODE11, PHARMA, PHARMA2T |
| is_bulk |
اختیاری
ui.admin.api_docs.common.types.بولی
|
— |
| value |
الزامی
ui.admin.api_docs.common.types.رشته
|
— |
| display_text |
اختیاری
ui.admin.api_docs.common.types.بولی
|
— |
| foreground_color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| background_color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| width_scale |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
1-10 |
| height |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
30-1000 |
نمونه پاسخ
{
"data": {
"id": 1
}
}
نقطه پایانی
POST https://rqrcode.com/api/barcodes/{barcode_id}
مثال
curl --request POST \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=لاس وگاس' \
--form 'value=123456'
پارامترها
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| project_id |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
— |
| name |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| type |
اختیاری
ui.admin.api_docs.common.types.رشته
|
مقادیر مجاز: C32, C39, C39+, C39E, C39E+, C93, S25, S25+, I25, I25+, ITF14, C128, C128A, C128B, C128C, EAN2, EAN5, EAN8, EAN13, UPCA, UPCE, MSI, MSI+, POSTNET, PLANET, TELEPENALPHA, TELEPENNUMERIC, RMS4CC, KIX, IMB, CODABAR, CODE11, PHARMA, PHARMA2T |
| value |
الزامی
ui.admin.api_docs.common.types.رشته
|
— |
| display_text |
اختیاری
ui.admin.api_docs.common.types.بولی
|
— |
| foreground_color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| background_color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| width_scale |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
1-10 |
| height |
اختیاری
ui.admin.api_docs.common.types.عدد صحیح
|
30-1000 |
نمونه پاسخ
{
"data": {
"id": 1
}
}
نقطه پایانی
DELETE https://rqrcode.com/api/barcodes/{barcode_id}
مثال
curl --request DELETE \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
بدنه پاسخ 200 در حالت موفقیت خالی است.