مستندات API
پروژهها
منابع خود را در پروژهها سازماندهی کنید.
احراز هویت
هر درخواست باید هدر Authorization را با توکن Bearer مطابق با کلید API مدیریت ارسال کند.
دریافت کلید API.
نقطه پایانی
GET https://rqrcode.com/api/projects/
مثال
curl --request GET \
--url 'https://rqrcode.com/api/projects/' \
--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,
"name": "توسعه",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/projects?page=1",
"last": "https://rqrcode.com/api/projects?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/projects?page=1"
}
}
نقطه پایانی
GET https://rqrcode.com/api/projects/{project_id}
مثال
curl --request GET \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
{
"data": {
"id": 1,
"name": "توسعه",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
}
نقطه پایانی
POST https://rqrcode.com/api/projects
مثال
curl --request POST \
--url 'https://rqrcode.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=تولید' \
--form 'color=#ffffff'
پارامترها
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| name |
الزامی
ui.admin.api_docs.common.types.رشته
|
— |
| color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
نمونه پاسخ
{
"data": {
"id": 1
}
}
نقطه پایانی
POST https://rqrcode.com/api/projects/{project_id}
مثال
curl --request POST \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=تولید' \
--form 'color=#000000'
پارامترها
| پارامترها | جزئیات | توضیحات |
|---|---|---|
| name |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
| color |
اختیاری
ui.admin.api_docs.common.types.رشته
|
— |
نمونه پاسخ
{
"data": {
"id": 1
}
}
نقطه پایانی
DELETE https://rqrcode.com/api/projects/{project_id}
مثال
curl --request DELETE \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
بدنه پاسخ 200 در حالت موفقیت خالی است.