API dokumentācija
QR kodi
Uzskaitiet, apskatiet, izveidojiet, atjauniniet un dzēsiet savus QR kodus.
Autentifikācija
Katram pieprasījumam jānosūta Authorization galvene ar Bearer marķieri, kas atbilst administratora API atslēgai.
Iegūt API atslēgu.
Gala punkts
GET https://rqrcode.com/api/qr-codes/
Piemērs
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
Parametri
| Parametri | Detaļas | Apraksts |
|---|---|---|
| page |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
Lapas numurs, kurai vēlaties iegūt rezultātus. Noklusējums ir 1. |
| results_per_page |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
Cik rezultātu vēlaties vienā lapā. Atļautās vērtības: 10, 25, 50, 100, 250, 500, 1000. Noklusējums ir 25. |
Atbildes piemērs
{
"data": [
{
"id": 1,
"type": "url",
"name": "Piemēra nosaukums",
"qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
"qr_code_logo": null,
"qr_code_background": null,
"settings": {
"foreground_type": "color",
"foreground_color": "#000000",
"background_color": "#ffffff",
"custom_eyes_color": false,
"qr_code_logo_size": 25,
"size": 500,
"margin": 0,
"ecc": "L",
"url": "https://example.com",
"...": "..."
},
"embedded_data": "https://example.com",
"last_datetime": null,
"datetime": "2026-04-20 07:52:15"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/qr-codes?page=1",
"last": "https://rqrcode.com/api/qr-codes?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/qr-codes?page=1"
}
}
Gala punkts
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
Piemērs
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametri
Nav papildu parametru.
Atbildes piemērs
{
"data": {
"id": 1,
"type": "url",
"name": "Piemēra nosaukums",
"qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
"qr_code_logo": null,
"qr_code_background": null,
"settings": {
"foreground_type": "color",
"foreground_color": "#000000",
"background_color": "#ffffff",
"custom_eyes_color": false,
"qr_code_logo_size": 25,
"size": 500,
"margin": 0,
"ecc": "L",
"url": "https://example.com",
"...": "..."
},
"embedded_data": "https://example.com",
"last_datetime": null,
"datetime": "2026-04-20 07:52:15"
}
}
Gala punkts
POST https://rqrcode.com/api/qr-codes
Piemērs
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Ņujorka' \
--form 'type=text' \
--form 'text=Sveiki!'
Parametri
| Parametri | Detaļas | Apraksts |
|---|---|---|
| link_id |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
- |
| project_id |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
- |
| name |
Obligāts
ui.admin.api_docs.common.types.Virkne
|
- |
| type |
Obligāts
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| is_bulk |
Neobligāti
ui.admin.api_docs.common.types.Būla vērtība
|
Pieejams, kad: type = text |
| style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x |
| inner_eye_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, circle, rounded, flower, leaf |
| foreground_type |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: color, gradient |
| foreground_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = color |
| foreground_gradient_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = gradient |
| foreground_gradient_two |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = gradient |
| background_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| background_color_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
- |
| custom_eyes_color |
Neobligāti
ui.admin.api_docs.common.types.Būla vērtība
|
- |
| eyes_inner_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: custom_eyes_color = 1 |
| eyes_outer_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: custom_eyes_color = 1 |
| qr_code_logo |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_logo_size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
5-35 |
| qr_code_background |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_background_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-100 |
| qr_code_foreground |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_foreground_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-100 |
| frame |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text |
| frame_text |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| frame_text_size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
-5 - 5 |
| frame_text_font |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt |
| frame_custom_colors |
Neobligāti
ui.admin.api_docs.common.types.Būla vērtība
|
- |
| frame_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: frame_custom_colors = 1 |
| frame_text_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: frame_custom_colors = 1 |
| size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
50-2000 |
| margin |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-25 |
| ecc |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: L, M, Q, H |
| text |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = text |
| url |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = url |
| phone |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = phone |
| sms |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = sms |
|
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = email | |
|
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = whatsapp | |
| facetime |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = facetime |
| event |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = event |
| location |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| wifi |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| crypto |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| vcard |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| paypal |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| upi |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| epc |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| pix |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| coupon |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| google_review |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
Atbildes piemērs
{
"data": {
"id": 1
}
}
Gala punkts
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
Piemērs
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Lasvegasa'
Parametri
| Parametri | Detaļas | Apraksts |
|---|---|---|
| link_id |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
- |
| project_id |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| name |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| type |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x |
| inner_eye_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: square, circle, rounded, flower, leaf |
| foreground_type |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: color, gradient |
| foreground_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = color |
| foreground_gradient_style |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = gradient |
| foreground_gradient_two |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: foreground_type = gradient |
| background_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| background_color_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0 - 100 |
| custom_eyes_color |
Neobligāti
ui.admin.api_docs.common.types.Būla vērtība
|
- |
| eyes_inner_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: custom_eyes_color = 1 |
| eyes_outer_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: custom_eyes_color = 1 |
| qr_code_logo |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_logo_size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
5-35 |
| qr_code_background |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_background_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-100 |
| qr_code_foreground |
Neobligāti
ui.admin.api_docs.common.types.Fails
|
- |
| qr_code_foreground_transparency |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-100 |
| frame |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text |
| frame_text |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
- |
| frame_text_size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
-5 -> 5 |
| frame_text_font |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt |
| frame_custom_colors |
Neobligāti
ui.admin.api_docs.common.types.Būla vērtība
|
- |
| frame_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: frame_custom_colors = 1 |
| frame_text_color |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: frame_custom_colors = 1 |
| size |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
50-2000 |
| margin |
Neobligāti
ui.admin.api_docs.common.types.Vesels skaitlis
|
0-25 |
| ecc |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Atļautās vērtības: L, M, Q, H |
| text |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = text |
| url |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = url |
| phone |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = phone |
| sms |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = sms |
|
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = email | |
|
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = whatsapp | |
| facetime |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = facetime |
| event |
Neobligāti
ui.admin.api_docs.common.types.Virkne
|
Pieejams, kad: type = event |
| location |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| wifi |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| crypto |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| vcard |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| paypal |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| upi |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| epc |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| pix |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| coupon |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
| google_review |
Neobligāti
ui.admin.api_docs.common.types.Objekts
|
- |
Atbildes piemērs
{
"data": {
"id": 1
}
}
Gala punkts
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
Piemērs
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parametri
Nav papildu parametru.
Atbildes piemērs
Tukša 200 atbildes pamatteksta atbilde veiksmes gadījumā.