API-dokumentaatio
Projektit
Järjestä resurssisi projektien sisällä.
Todennus
Kaikkien pyyntöjen on lähetettävä Authorization-otsikko, jossa on ylläpitäjän API-avaimeen sopiva Bearer-token.
Hae API-avain.
Päätepiste
GET https://rqrcode.com/api/projects/
Esimerkki
curl --request GET \
--url 'https://rqrcode.com/api/projects/' \
--header 'Authorization: Bearer {api_key}'
Parametrit
| Parametrit | Yksityiskohdat | Kuvaus |
|---|---|---|
| page |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
Sivunumero, jolle haluat saada tulokset. Oletusarvo on 1. |
| results_per_page |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
Kuinka monta tulosta haluat per sivu. Sallitut arvot ovat: 10, 25, 50, 100, 250, 500, 1000. Oletusarvo on 25. |
Vastausesimerkki
{
"data": [
{
"id": 1,
"name": "Kehitys",
"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"
}
}
Päätepiste
GET https://rqrcode.com/api/projects/{project_id}
Esimerkki
curl --request GET \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrit
Ei lisäparametreja.
Vastausesimerkki
{
"data": {
"id": 1,
"name": "Kehitys",
"color": "#0e23cc",
"last_datetime": null,
"datetime": "2026-04-20 07:54:04"
}
}
Päätepiste
POST https://rqrcode.com/api/projects
Esimerkki
curl --request POST \
--url 'https://rqrcode.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Tuotanto' \
--form 'color=#ffffff'
Parametrit
| Parametrit | Yksityiskohdat | Kuvaus |
|---|---|---|
| name |
Pakollinen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
Vastausesimerkki
{
"data": {
"id": 1
}
}
Päätepiste
POST https://rqrcode.com/api/projects/{project_id}
Esimerkki
curl --request POST \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Tuotanto' \
--form 'color=#000000'
Parametrit
| Parametrit | Yksityiskohdat | Kuvaus |
|---|---|---|
| name |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
Vastausesimerkki
{
"data": {
"id": 1
}
}
Päätepiste
DELETE https://rqrcode.com/api/projects/{project_id}
Esimerkki
curl --request DELETE \
--url 'https://rqrcode.com/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrit
Ei lisäparametreja.
Vastausesimerkki
Onnistumisen yhteydessä tyhjä 200-vastausrunko.