Códigos QR

Recuperar tudo

GET https://linkbio.pro/api/qr-codes/
curl --request GET \
--url 'https://linkbio.pro/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros 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://linkbio.pro/uploads/qr_code/example.svg", "qr_code_logo": 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" }, "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://linkbio.pro/api/qr-codes?&page=1", "last": "https://linkbio.pro/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://linkbio.pro/api/qr-codes?&page=1" } }

Recuperar um

GET https://linkbio.pro/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://linkbio.pro/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://linkbio.pro/uploads/qr_code/example.svg", "qr_code_logo": 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" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Criar

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

Atualizar

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

Excluir

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