Dokumentasi API
Projek
Susun sumber anda dalam projek.
Pengesahan
Setiap permintaan mesti menghantar pengepala Authorization dengan token Bearer yang sepadan dengan kunci API admin.
Dapatkan kunci API.
Titik akhir
GET https://rqrcode.com/api/projects/
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/projects/' \
--header 'Authorization: Bearer {api_key}'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| page |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Nombor halaman yang anda ingin dapatkan hasilnya. Lalai kepada 1. |
| results_per_page |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Berapa banyak hasil yang anda mahu setiap halaman. Nilai yang dibenarkan ialah: 10, 25, 50, 100, 250, 500, 1000. Lalai kepada 25. |
Contoh respons
{
"data": [
{
"id": 1,
"name": "Pembangunan",
"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"
}
}
Titik akhir
GET https://rqrcode.com/api/projects/{project_id}
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
{
"data": {
"id": 1,
"name": "Pembangunan",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
}
Titik akhir
POST https://rqrcode.com/api/projects
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Pengeluaran' \
--form 'color=#ffffff'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| name |
Diperlukan
ui.admin.api_docs.common.types.Rentetan
|
- |
| color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
POST https://rqrcode.com/api/projects/{project_id}
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Pengeluaran' \
--form 'color=#000000'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| name |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
DELETE https://rqrcode.com/api/projects/{project_id}
Contoh
curl --request DELETE \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
Badan respons 200 kosong apabila berjaya.