Документація 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 у разі успіху.