API-dokumentaatio
Viivakoodit
Hallitse viivakoodejasi ja niiden vientiasetuksia.
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/barcodes/
Esimerkki
curl --request GET \
--url 'https://rqrcode.com/api/barcodes/' \
--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,
"type": "C32",
"name": "Esimerkki nimi",
"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"
}
}
Päätepiste
GET https://rqrcode.com/api/barcodes/{barcode_id}
Esimerkki
curl --request GET \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrit
Ei lisäparametreja.
Vastausesimerkki
{
"data": {
"id": 1,
"type": "C32",
"name": "Esimerkki nimi",
"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"
}
}
Päätepiste
POST https://rqrcode.com/api/barcodes
Esimerkki
curl --request POST \
--url 'https://rqrcode.com/api/barcodes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Helsinki' \
--form 'type=C32' \
--form 'value=123456'
Parametrit
| Parametrit | Yksityiskohdat | Kuvaus |
|---|---|---|
| project_id |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
Ei kuvausta |
| name |
Pakollinen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| type |
Pakollinen
ui.admin.api_docs.common.types.Merkkijono
|
Sallitut arvot: 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 |
Valinnainen
ui.admin.api_docs.common.types.Totuusarvo
|
Ei kuvausta |
| value |
Pakollinen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| display_text |
Valinnainen
ui.admin.api_docs.common.types.Totuusarvo
|
Ei kuvausta |
| foreground_color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| background_color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| width_scale |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
1-10 |
| height |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
30-1000 |
Vastausesimerkki
{
"data": {
"id": 1
}
}
Päätepiste
POST https://rqrcode.com/api/barcodes/{barcode_id}
Esimerkki
curl --request POST \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Tampere' \
--form 'value=123456'
Parametrit
| Parametrit | Yksityiskohdat | Kuvaus |
|---|---|---|
| project_id |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
Ei kuvausta |
| name |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| type |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Sallitut arvot: 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 |
Pakollinen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| display_text |
Valinnainen
ui.admin.api_docs.common.types.Totuusarvo
|
Ei kuvausta |
| foreground_color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| background_color |
Valinnainen
ui.admin.api_docs.common.types.Merkkijono
|
Ei kuvausta |
| width_scale |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
1-10 |
| height |
Valinnainen
ui.admin.api_docs.common.types.Kokonaisluku
|
30-1000 |
Vastausesimerkki
{
"data": {
"id": 1
}
}
Päätepiste
DELETE https://rqrcode.com/api/barcodes/{barcode_id}
Esimerkki
curl --request DELETE \
--url 'https://rqrcode.com/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrit
Ei lisäparametreja.
Vastausesimerkki
Onnistumisen yhteydessä tyhjä 200-vastausrunko.