Installez notre application 🪄 Cliquez sur l'icône en haut à droite de la barre d'adresse.

Codes QR

GET https://www.your.bzh/api/qr-codes/
curl --request GET \
--url 'https://www.your.bzh/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
page Optionnel Entier Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut 1.
results_per_page Optionnel Entier Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut, 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://www.your.bzh/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": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://www.your.bzh/api/qr-codes?&page=1", "last": "https://www.your.bzh/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://www.your.bzh/api/qr-codes?&page=1" } }
GET https://www.your.bzh/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://www.your.bzh/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://www.your.bzh/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": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }
POST https://www.your.bzh/api/qr-codes
Paramètres Détails Description
project_id Optionnel Entier -
name Requis Chaîne -
type Requis Chaîne Valeurs autorisées : text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Optionnel Booléen Disponible lorsque : type = text
style Optionnel Chaîne Valeurs autorisées : square, dot, round, diamond, heart
inner_eye_style Optionnel Chaîne Valeurs autorisées : square, dot, rounded, diamond, flower, leaf
outer_eye_style Optionnel Chaîne Valeurs autorisées : square, circle, rounded, flower, leaf
foreground_type Optionnel Chaîne Valeurs autorisées : color, gradient
foreground_color Optionnel Chaîne Disponible lorsque : foreground_type = color
foreground_gradient_style Optionnel Chaîne Valeurs autorisées : vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Optionnel Chaîne Disponible lorsque : foreground_type = gradient
foreground_gradient_two Optionnel Chaîne Disponible lorsque : foreground_type = gradient
background_color Optionnel Chaîne
background_color_transparency Optionnel Entier
custom_eyes_color Optionnel Booléen
eyes_inner_color Optionnel Chaîne Disponible lorsque : custom_eyes_color = 1
eyes_outer_color Optionnel Chaîne Disponible lorsque : custom_eyes_color = 1
qr_code_logo Optionnel Fichier -
qr_code_logo_size Optionnel Entier 5-35
qr_code_background Optionnel Fichier -
qr_code_background_transparency Optionnel Entier 0-100
qr_code_foreground Optionnel Fichier -
qr_code_foreground_transparency Optionnel Entier 0-100
frame Optionnel Chaîne Valeurs autorisées : 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
frame_text Optionnel Chaîne
frame_text_size Optionnel Entier -5 - 5
frame_text_font Optionnel Chaîne Valeurs autorisées : 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 Optionnel Booléen
frame_color Optionnel Chaîne Disponible lorsque : frame_custom_colors = 1
frame_text_color Optionnel Chaîne Disponible lorsque : frame_custom_colors = 1
size Optionnel Entier 50-2000
margin Optionnel Entier 0-25
ecc Optionnel Chaîne Valeurs autorisées : L, M, Q, H
text Optionnel Chaîne Disponible lorsque : type = text
url Optionnel Chaîne Disponible lorsque : type = url
phone Optionnel Chaîne Disponible lorsque : type = phone
sms Optionnel Chaîne Disponible lorsque : type = sms
sms_body Optionnel Chaîne Disponible lorsque : type = sms
email Optionnel Chaîne Disponible lorsque : type = email
whatsapp Optionnel Chaîne Disponible lorsque : type = whatsapp
whatsapp_body Optionnel Chaîne Disponible lorsque : type = whatsapp
facetime Optionnel Chaîne Disponible lorsque : type = facetime
location
location_latitude Optionnel Flottant Disponible lorsque : type = location
location_longitude Optionnel Flottant Disponible lorsque : type = location
wifi
wifi_ssid Optionnel Chaîne Disponible lorsque : type = wifi
wifi_encryption Optionnel Chaîne Valeurs autorisées : nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Optionnel Chaîne Disponible lorsque : type = wifi
wifi_is_hidden Optionnel Booléen Disponible lorsque : type = wifi
event Optionnel Chaîne Disponible lorsque : type = event
event_location Optionnel Chaîne Disponible lorsque : type = event
event_url Optionnel Chaîne Disponible lorsque : type = event
event_note Optionnel Chaîne Disponible lorsque : type = event
event_timezone Optionnel Chaîne Disponible lorsque : type = event
event_start_datetime Optionnel Chaîne Disponible lorsque : type = event
event_end_datetime Optionnel Chaîne Disponible lorsque : type = event
event_first_alert_datetime Optionnel Chaîne Disponible lorsque : type = event
event_second_alert_datetime Optionnel Chaîne Disponible lorsque : type = event
crypto
crypto_coin Optionnel Chaîne Disponible lorsque : type = crypto
crypto_address Optionnel Chaîne Disponible lorsque : type = crypto
crypto_amount Optionnel Chaîne Disponible lorsque : type = crypto
vcard
vcard_first_name Optionnel Chaîne Disponible lorsque : type = vcard
vcard_last_name Optionnel Chaîne Disponible lorsque : type = vcard
vcard_company Optionnel Chaîne Disponible lorsque : type = vcard
vcard_phone_number_label[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_phone_number_value[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_email Optionnel Chaîne Disponible lorsque : type = vcard
vcard_url Optionnel Chaîne Disponible lorsque : type = vcard
vcard_job_title Optionnel Chaîne Disponible lorsque : type = vcard
vcard_birthday Optionnel Chaîne Disponible lorsque : type = vcard
vcard_street Optionnel Chaîne Disponible lorsque : type = vcard
vcard_city Optionnel Chaîne Disponible lorsque : type = vcard
vcard_zip Optionnel Chaîne Disponible lorsque : type = vcard
vcard_region Optionnel Chaîne Disponible lorsque : type = vcard
vcard_country Optionnel Chaîne Disponible lorsque : type = vcard
vcard_note Optionnel Chaîne Disponible lorsque : type = vcard
vcard_social_label[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_social_value[index] Optionnel Chaîne Disponible lorsque : type = vcard
paypal
paypal_type Optionnel Chaîne Valeurs autorisées : buy_now, add_to_cart, donation (type=paypal)
paypal_email Optionnel Chaîne Disponible lorsque : type = paypal
paypal_title Optionnel Chaîne Disponible lorsque : type = paypal
paypal_currency Optionnel Chaîne Disponible lorsque : type = paypal
paypal_price Optionnel Flottant Disponible lorsque : type = paypal
paypal_thank_you_url Optionnel Chaîne Disponible lorsque : type = paypal
paypal_cancel_url Optionnel Chaîne Disponible lorsque : type = paypal
upi
upi_payee_id Optionnel Chaîne Disponible lorsque : type = upi
upi_payee_name Optionnel Chaîne Disponible lorsque : type = upi
upi_currency Optionnel Chaîne Disponible lorsque : type = upi
upi_amount Optionnel Flottant Disponible lorsque : type = upi
upi_transaction_id Optionnel Chaîne Disponible lorsque : type = upi
upi_transaction_note Optionnel Chaîne Disponible lorsque : type = upi
upi_transaction_reference Optionnel Chaîne Disponible lorsque : type = upi
upi_thank_you_url Optionnel Chaîne Disponible lorsque : type = upi
epc
epc_iban Optionnel Chaîne Disponible lorsque : type = epc
epc_payee_name Optionnel Chaîne Disponible lorsque : type = epc
epc_currency Optionnel Chaîne Disponible lorsque : type = epc
epc_amount Optionnel Flottant Disponible lorsque : type = epc
epc_bic Optionnel Chaîne Disponible lorsque : type = epc
epc_remittance_reference Optionnel Chaîne Disponible lorsque : type = epc
epc_remittance_text Optionnel Chaîne Disponible lorsque : type = epc
information Optionnel Chaîne Disponible lorsque : type = epc
pix
pix_payee_key Optionnel Chaîne Disponible lorsque : type = pix
pix_payee_name Optionnel Chaîne Disponible lorsque : type = pix
pix_currency Optionnel Chaîne Disponible lorsque : type = pix
pix_amount Optionnel Flottant Disponible lorsque : type = pix
pix_city Optionnel Chaîne Disponible lorsque : type = pix
pix_transaction_id Optionnel Chaîne Disponible lorsque : type = pix
pix_description Optionnel Chaîne Disponible lorsque : type = pix
Paramètres Détails Description
curl --request POST \
--url 'https://www.your.bzh/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \
{ "data": { "id": 1 } }
POST https://www.your.bzh/api/qr-codes/{qr_code_id}
Paramètres Détails Description
project_id Optionnel Chaîne -
name Optionnel Chaîne -
type Optionnel Chaîne Valeurs autorisées : text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style Optionnel Chaîne Valeurs autorisées : square, dot, round, diamond, heart
inner_eye_style Optionnel Chaîne Valeurs autorisées : square, dot, rounded, diamond, flower, leaf
outer_eye_style Optionnel Chaîne Valeurs autorisées : square, circle, rounded, flower, leaf
foreground_type Optionnel Chaîne Valeurs autorisées : color, gradient
foreground_color Optionnel Chaîne Disponible lorsque : foreground_type = color
foreground_gradient_style Optionnel Chaîne Valeurs autorisées : vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Optionnel Chaîne Disponible lorsque : foreground_type = gradient
foreground_gradient_two Optionnel Chaîne Disponible lorsque : foreground_type = gradient
background_color Optionnel Chaîne
background_color_transparency Optionnel Entier 0 - 100
custom_eyes_color Optionnel Booléen
eyes_inner_color Optionnel Chaîne Disponible lorsque : custom_eyes_color = 1
eyes_outer_color Optionnel Chaîne Disponible lorsque : custom_eyes_color = 1
qr_code_logo Optionnel Fichier -
qr_code_logo_size Optionnel Entier 5-35
qr_code_background Optionnel Fichier -
qr_code_background_transparency Optionnel Entier 0-100
qr_code_foreground Optionnel Fichier -
qr_code_foreground_transparency Optionnel Entier 0-100
frame Optionnel Chaîne Valeurs autorisées : 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
frame_text Optionnel Chaîne
frame_text_size Optionnel Entier -5 -> 5
frame_text_font Optionnel Chaîne Valeurs autorisées : 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 Optionnel Booléen
frame_color Optionnel Chaîne Disponible lorsque : frame_custom_colors = 1
frame_text_color Optionnel Chaîne Disponible lorsque : frame_custom_colors = 1
size Optionnel Entier 50-2000
margin Optionnel Entier 0-25
ecc Optionnel Chaîne Valeurs autorisées : L, M, Q, H
text Optionnel Chaîne Disponible lorsque : type = text
url Optionnel Chaîne Disponible lorsque : type = url
phone Optionnel Chaîne Disponible lorsque : type = phone
sms Optionnel Chaîne Disponible lorsque : type = sms
sms_body Optionnel Chaîne Disponible lorsque : type = sms
email Optionnel Chaîne Disponible lorsque : type = email
whatsapp Optionnel Chaîne Disponible lorsque : type = whatsapp
whatsapp_body Optionnel Chaîne Disponible lorsque : type = whatsapp
facetime Optionnel Chaîne Disponible lorsque : type = facetime
location
location_latitude Optionnel Flottant Disponible lorsque : type = location
location_longitude Optionnel Flottant Disponible lorsque : type = location
wifi
wifi_ssid Optionnel Chaîne Disponible lorsque : type = wifi
wifi_encryption Optionnel Chaîne Valeurs autorisées : nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Optionnel Chaîne Disponible lorsque : type = wifi
wifi_is_hidden Optionnel Booléen Disponible lorsque : type = wifi
event Optionnel Chaîne Disponible lorsque : type = event
event_location Optionnel Chaîne Disponible lorsque : type = event
event_url Optionnel Chaîne Disponible lorsque : type = event
event_note Optionnel Chaîne Disponible lorsque : type = event
event_timezone Optionnel Chaîne Disponible lorsque : type = event
event_start_datetime Optionnel Chaîne Disponible lorsque : type = event
event_end_datetime Optionnel Chaîne Disponible lorsque : type = event
event_first_alert_datetime Optionnel Chaîne Disponible lorsque : type = event
event_second_alert_datetime Optionnel Chaîne Disponible lorsque : type = event
crypto
crypto_coin Optionnel Chaîne Disponible lorsque : type = crypto
crypto_address Optionnel Chaîne Disponible lorsque : type = crypto
crypto_amount Optionnel Chaîne Disponible lorsque : type = crypto
vcard
vcard_first_name Optionnel Chaîne Disponible lorsque : type = vcard
vcard_last_name Optionnel Chaîne Disponible lorsque : type = vcard
vcard_company Optionnel Chaîne Disponible lorsque : type = vcard
vcard_phone_number_label[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_phone_number_value[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_email Optionnel Chaîne Disponible lorsque : type = vcard
vcard_url Optionnel Chaîne Disponible lorsque : type = vcard
vcard_job_title Optionnel Chaîne Disponible lorsque : type = vcard
vcard_birthday Optionnel Chaîne Disponible lorsque : type = vcard
vcard_street Optionnel Chaîne Disponible lorsque : type = vcard
vcard_city Optionnel Chaîne Disponible lorsque : type = vcard
vcard_zip Optionnel Chaîne Disponible lorsque : type = vcard
vcard_region Optionnel Chaîne Disponible lorsque : type = vcard
vcard_country Optionnel Chaîne Disponible lorsque : type = vcard
vcard_note Optionnel Chaîne Disponible lorsque : type = vcard
vcard_social_label[index] Optionnel Chaîne Disponible lorsque : type = vcard
vcard_social_value[index] Optionnel Chaîne Disponible lorsque : type = vcard
paypal
paypal_type Optionnel Chaîne Valeurs autorisées : buy_now, add_to_cart, donation (type=paypal)
paypal_email Optionnel Chaîne Disponible lorsque : type = paypal
paypal_title Optionnel Chaîne Disponible lorsque : type = paypal
paypal_currency Optionnel Chaîne Disponible lorsque : type = paypal
paypal_price Optionnel Flottant Disponible lorsque : type = paypal
paypal_thank_you_url Optionnel Chaîne Disponible lorsque : type = paypal
paypal_cancel_url Optionnel Chaîne Disponible lorsque : type = paypal
upi
upi_payee_id Optionnel Chaîne Disponible lorsque : type = upi
upi_payee_name Optionnel Chaîne Disponible lorsque : type = upi
upi_currency Optionnel Chaîne Disponible lorsque : type = upi
upi_amount Optionnel Flottant Disponible lorsque : type = upi
upi_transaction_id Optionnel Chaîne Disponible lorsque : type = upi
upi_transaction_note Optionnel Chaîne Disponible lorsque : type = upi
upi_transaction_reference Optionnel Chaîne Disponible lorsque : type = upi
upi_thank_you_url Optionnel Chaîne Disponible lorsque : type = upi
epc
epc_iban Optionnel Chaîne Disponible lorsque : type = epc
epc_payee_name Optionnel Chaîne Disponible lorsque : type = epc
epc_currency Optionnel Chaîne Disponible lorsque : type = epc
epc_amount Optionnel Flottant Disponible lorsque : type = epc
epc_bic Optionnel Chaîne Disponible lorsque : type = epc
epc_remittance_reference Optionnel Chaîne Disponible lorsque : type = epc
epc_remittance_text Optionnel Chaîne Disponible lorsque : type = epc
information Optionnel Chaîne Disponible lorsque : type = epc
pix
pix_payee_key Optionnel Chaîne Disponible lorsque : type = pix
pix_payee_name Optionnel Chaîne Disponible lorsque : type = pix
pix_currency Optionnel Chaîne Disponible lorsque : type = pix
pix_amount Optionnel Flottant Disponible lorsque : type = pix
pix_city Optionnel Chaîne Disponible lorsque : type = pix
pix_transaction_id Optionnel Chaîne Disponible lorsque : type = pix
pix_description Optionnel Chaîne Disponible lorsque : type = pix
curl --request POST \
--url 'https://www.your.bzh/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }
DELETE https://www.your.bzh/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://www.your.bzh/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \