QR codes

Retrieve all

GET https://easytap.com.br/api/qr-codes/
curl --request GET \
--url 'https://easytap.com.br/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Detalhes Descrição
page Opcional Integer O número da página da qual você deseja resultados. O padrão é 1.
results_per_page Opcional Integer Quantos resultados você deseja por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://easytap.com.br/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://easytap.com.br/api/qr-codes?&page=1", "last": "https://easytap.com.br/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://easytap.com.br/api/qr-codes?&page=1" } }

Retrieve one

GET https://easytap.com.br/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://easytap.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://easytap.com.br/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" } }

Create

POST https://easytap.com.br/api/qr-codes
Parameters Detalhes Descrição
project_id Opcional Integer -
name Obrigatório String -
type Obrigatório String Valores permitidos: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Opcional Boolean Disponível quando: type = text
style Opcional String Valores permitidos: square, dot, round, diamond, heart
inner_eye_style Opcional String Valores permitidos: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opcional String Valores permitidos: square, circle, rounded, flower, leaf
foreground_type Opcional String Valores permitidos: color, gradient
foreground_color Opcional String Disponível quando: foreground_type = color
foreground_gradient_style Opcional String Valores permitidos: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opcional String Disponível quando: foreground_type = gradient
foreground_gradient_two Opcional String Disponível quando: foreground_type = gradient
background_color Opcional String
background_color_transparency Opcional Integer
custom_eyes_color Opcional Boolean
eyes_inner_color Opcional String Disponível quando: custom_eyes_color = 1
eyes_outer_color Opcional String Disponível quando: custom_eyes_color = 1
qr_code_logo Opcional Boolean -
qr_code_logo_size Opcional Integer 5-35
qr_code_background Opcional Boolean -
qr_code_background_transparency Opcional Integer 0-100
qr_code_foreground Opcional Boolean -
qr_code_foreground_transparency Opcional Integer 0-100
frame Opcional String Valores permitidos: 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 Opcional String
frame_text_size Opcional Integer -5 - 5
frame_text_font Opcional String Valores permitidos: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Opcional Boolean
frame_color Opcional String Disponível quando: frame_custom_colors = 1
frame_text_color Opcional String Disponível quando: frame_custom_colors = 1
size Opcional Integer 50-2000
margin Opcional Integer 0-25
ecc Opcional String Valores permitidos: L, M, Q, H
text Opcional String Disponível quando: type = text
url Opcional String Disponível quando: type = url
phone Opcional String Disponível quando: type = phone
sms Opcional String Disponível quando: type = sms
sms_body Opcional String Disponível quando: type = sms
email Opcional String Disponível quando: type = email
whatsapp Opcional String Disponível quando: type = whatsapp
whatsapp_body Opcional String Disponível quando: type = whatsapp
facetime Opcional String Disponível quando: type = facetime
location
location_latitude Opcional Float Disponível quando: type = location
location_longitude Opcional Float Disponível quando: type = location
wifi
wifi_ssid Opcional String Disponível quando: type = wifi
wifi_encryption Opcional String Valores permitidos: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opcional String Disponível quando: type = wifi
wifi_is_hidden Opcional Boolean Disponível quando: type = wifi
event Opcional String Disponível quando: type = event
event_location Opcional String Disponível quando: type = event
event_url Opcional String Disponível quando: type = event
event_note Opcional String Disponível quando: type = event
event_timezone Opcional String Disponível quando: type = event
event_start_datetime Opcional String Disponível quando: type = event
event_end_datetime Opcional String Disponível quando: type = event
event_first_alert_datetime Opcional String Disponível quando: type = event
event_second_alert_datetime Opcional String Disponível quando: type = event
crypto
crypto_coin Opcional String Disponível quando: type = crypto
crypto_address Opcional String Disponível quando: type = crypto
crypto_amount Opcional String Disponível quando: type = crypto
vcard
vcard_first_name Opcional String Disponível quando: type = vcard
vcard_last_name Opcional String Disponível quando: type = vcard
vcard_company Opcional String Disponível quando: type = vcard
vcard_phone_number_label[index] Opcional String Disponível quando: type = vcard
vcard_phone_number_value[index] Opcional String Disponível quando: type = vcard
vcard_email Opcional String Disponível quando: type = vcard
vcard_url Opcional String Disponível quando: type = vcard
vcard_job_title Opcional String Disponível quando: type = vcard
vcard_birthday Opcional String Disponível quando: type = vcard
vcard_street Opcional String Disponível quando: type = vcard
vcard_city Opcional String Disponível quando: type = vcard
vcard_zip Opcional String Disponível quando: type = vcard
vcard_region Opcional String Disponível quando: type = vcard
vcard_country Opcional String Disponível quando: type = vcard
vcard_note Opcional String Disponível quando: type = vcard
vcard_social_label[index] Opcional String Disponível quando: type = vcard
vcard_social_value[index] Opcional String Disponível quando: type = vcard
paypal
paypal_type Opcional String Valores permitidos: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opcional String Disponível quando: type = paypal
paypal_title Opcional String Disponível quando: type = paypal
paypal_currency Opcional String Disponível quando: type = paypal
paypal_price Opcional Float Disponível quando: type = paypal
paypal_thank_you_url Opcional String Disponível quando: type = paypal
paypal_cancel_url Opcional String Disponível quando: type = paypal
upi
upi_payee_id Opcional String Disponível quando: type = upi
upi_payee_name Opcional String Disponível quando: type = upi
upi_currency Opcional String Disponível quando: type = upi
upi_amount Opcional Float Disponível quando: type = upi
upi_transaction_id Opcional String Disponível quando: type = upi
upi_transaction_note Opcional String Disponível quando: type = upi
upi_transaction_reference Opcional String Disponível quando: type = upi
upi_thank_you_url Opcional String Disponível quando: type = upi
epc
epc_iban Opcional String Disponível quando: type = epc
epc_payee_name Opcional String Disponível quando: type = epc
epc_currency Opcional String Disponível quando: type = epc
epc_amount Opcional Float Disponível quando: type = epc
epc_bic Opcional String Disponível quando: type = epc
epc_remittance_reference Opcional String Disponível quando: type = epc
epc_remittance_text Opcional String Disponível quando: type = epc
information Opcional String Disponível quando: type = epc
pix
pix_payee_key Opcional String Disponível quando: type = pix
pix_payee_name Opcional String Disponível quando: type = pix
pix_currency Opcional String Disponível quando: type = pix
pix_amount Opcional Float Disponível quando: type = pix
pix_city Opcional String Disponível quando: type = pix
pix_transaction_id Opcional String Disponível quando: type = pix
pix_description Opcional String Disponível quando: type = pix
Parameters Detalhes Descrição
curl --request POST \
--url 'https://easytap.com.br/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 } }

Update

POST https://easytap.com.br/api/qr-codes/{qr_code_id}
Parameters Detalhes Descrição
project_id Opcional String -
name Opcional String -
type Opcional String Valores permitidos: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style Opcional String Valores permitidos: square, dot, round, diamond, heart
inner_eye_style Opcional String Valores permitidos: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opcional String Valores permitidos: square, circle, rounded, flower, leaf
foreground_type Opcional String Valores permitidos: color, gradient
foreground_color Opcional String Disponível quando: foreground_type = color
foreground_gradient_style Opcional String Valores permitidos: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opcional String Disponível quando: foreground_type = gradient
foreground_gradient_two Opcional String Disponível quando: foreground_type = gradient
background_color Opcional String
background_color_transparency Opcional Integer 0 - 100
custom_eyes_color Opcional Boolean
eyes_inner_color Opcional String Disponível quando: custom_eyes_color = 1
eyes_outer_color Opcional String Disponível quando: custom_eyes_color = 1
qr_code_logo Opcional Boolean -
qr_code_logo_size Opcional Integer 5-35
qr_code_background Opcional Boolean -
qr_code_background_transparency Opcional Integer 0-100
qr_code_foreground Opcional Boolean -
qr_code_foreground_transparency Opcional Integer 0-100
frame Opcional String Valores permitidos: 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 Opcional String
frame_text_size Opcional Integer -5 -> 5
frame_text_font Opcional String Valores permitidos: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Opcional Boolean
frame_color Opcional String Disponível quando: frame_custom_colors = 1
frame_text_color Opcional String Disponível quando: frame_custom_colors = 1
size Opcional Integer 50-2000
margin Opcional Integer 0-25
ecc Opcional String Valores permitidos: L, M, Q, H
text Opcional String Disponível quando: type = text
url Opcional String Disponível quando: type = url
phone Opcional String Disponível quando: type = phone
sms Opcional String Disponível quando: type = sms
sms_body Opcional String Disponível quando: type = sms
email Opcional String Disponível quando: type = email
whatsapp Opcional String Disponível quando: type = whatsapp
whatsapp_body Opcional String Disponível quando: type = whatsapp
facetime Opcional String Disponível quando: type = facetime
location
location_latitude Opcional Float Disponível quando: type = location
location_longitude Opcional Float Disponível quando: type = location
wifi
wifi_ssid Opcional String Disponível quando: type = wifi
wifi_encryption Opcional String Valores permitidos: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opcional String Disponível quando: type = wifi
wifi_is_hidden Opcional Boolean Disponível quando: type = wifi
event Opcional String Disponível quando: type = event
event_location Opcional String Disponível quando: type = event
event_url Opcional String Disponível quando: type = event
event_note Opcional String Disponível quando: type = event
event_timezone Opcional String Disponível quando: type = event
event_start_datetime Opcional String Disponível quando: type = event
event_end_datetime Opcional String Disponível quando: type = event
event_first_alert_datetime Opcional String Disponível quando: type = event
event_second_alert_datetime Opcional String Disponível quando: type = event
crypto
crypto_coin Opcional String Disponível quando: type = crypto
crypto_address Opcional String Disponível quando: type = crypto
crypto_amount Opcional String Disponível quando: type = crypto
vcard
vcard_first_name Opcional String Disponível quando: type = vcard
vcard_last_name Opcional String Disponível quando: type = vcard
vcard_company Opcional String Disponível quando: type = vcard
vcard_phone_number_label[index] Opcional String Disponível quando: type = vcard
vcard_phone_number_value[index] Opcional String Disponível quando: type = vcard
vcard_email Opcional String Disponível quando: type = vcard
vcard_url Opcional String Disponível quando: type = vcard
vcard_job_title Opcional String Disponível quando: type = vcard
vcard_birthday Opcional String Disponível quando: type = vcard
vcard_street Opcional String Disponível quando: type = vcard
vcard_city Opcional String Disponível quando: type = vcard
vcard_zip Opcional String Disponível quando: type = vcard
vcard_region Opcional String Disponível quando: type = vcard
vcard_country Opcional String Disponível quando: type = vcard
vcard_note Opcional String Disponível quando: type = vcard
vcard_social_label[index] Opcional String Disponível quando: type = vcard
vcard_social_value[index] Opcional String Disponível quando: type = vcard
paypal
paypal_type Opcional String Valores permitidos: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opcional String Disponível quando: type = paypal
paypal_title Opcional String Disponível quando: type = paypal
paypal_currency Opcional String Disponível quando: type = paypal
paypal_price Opcional Float Disponível quando: type = paypal
paypal_thank_you_url Opcional String Disponível quando: type = paypal
paypal_cancel_url Opcional String Disponível quando: type = paypal
upi
upi_payee_id Opcional String Disponível quando: type = upi
upi_payee_name Opcional String Disponível quando: type = upi
upi_currency Opcional String Disponível quando: type = upi
upi_amount Opcional Float Disponível quando: type = upi
upi_transaction_id Opcional String Disponível quando: type = upi
upi_transaction_note Opcional String Disponível quando: type = upi
upi_transaction_reference Opcional String Disponível quando: type = upi
upi_thank_you_url Opcional String Disponível quando: type = upi
epc
epc_iban Opcional String Disponível quando: type = epc
epc_payee_name Opcional String Disponível quando: type = epc
epc_currency Opcional String Disponível quando: type = epc
epc_amount Opcional Float Disponível quando: type = epc
epc_bic Opcional String Disponível quando: type = epc
epc_remittance_reference Opcional String Disponível quando: type = epc
epc_remittance_text Opcional String Disponível quando: type = epc
information Opcional String Disponível quando: type = epc
pix
pix_payee_key Opcional String Disponível quando: type = pix
pix_payee_name Opcional String Disponível quando: type = pix
pix_currency Opcional String Disponível quando: type = pix
pix_amount Opcional Float Disponível quando: type = pix
pix_city Opcional String Disponível quando: type = pix
pix_transaction_id Opcional String Disponível quando: type = pix
pix_description Opcional String Disponível quando: type = pix
curl --request POST \
--url 'https://easytap.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }

Update

DELETE https://easytap.com.br/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://easytap.com.br/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \