QR Code

GET https://xyz.ayo.ke/api/qr-codes/
curl --request GET \
--url 'https://xyz.ayo.ke/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Detail Deskripsi
page Opsional Integer (Angka Bulat) Nomor halaman hasil yang mau diambil. Default: 1.
results_per_page Opsional Integer (Angka Bulat) Jumlah data per halaman. Nilai yang diizinkan: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Default: 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://xyz.ayo.ke/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://xyz.ayo.ke/api/qr-codes?&page=1", "last": "https://xyz.ayo.ke/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://xyz.ayo.ke/api/qr-codes?&page=1" } }
GET https://xyz.ayo.ke/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://xyz.ayo.ke/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://xyz.ayo.ke/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" } }
POST https://xyz.ayo.ke/api/qr-codes
Parameter Detail Deskripsi
project_id Opsional Integer (Angka Bulat) -
name Wajib String (Teks) -
type Wajib String (Teks) Nilai yang diizinkan: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc
style Opsional String (Teks) Nilai yang diizinkan: square, dot, round, diamond, heart
inner_eye_style Opsional String (Teks) Nilai yang diizinkan: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opsional String (Teks) Nilai yang diizinkan: square, circle, rounded, flower, leaf
foreground_type Opsional String (Teks) Nilai yang diizinkan: color, gradient
foreground_color Opsional String (Teks) Tersedia saat: foreground_type = color
foreground_gradient_style Opsional String (Teks) Nilai yang diizinkan: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opsional String (Teks) Tersedia saat: foreground_type = gradient
foreground_gradient_two Opsional String (Teks) Tersedia saat: foreground_type = gradient
background_color Opsional String (Teks)
background_color_transparency Opsional Integer (Angka Bulat)
custom_eyes_color Opsional Boolean (True/False)
eyes_inner_color Opsional String (Teks) Tersedia saat: custom_eyes_color = 1
eyes_outer_color Opsional String (Teks) Tersedia saat: custom_eyes_color = 1
qr_code_logo Opsional File -
qr_code_logo_size Opsional Integer (Angka Bulat) 5-35
qr_code_background Opsional File -
qr_code_background_transparency Opsional Integer (Angka Bulat) 0-100
frame Opsional String (Teks) Nilai yang diizinkan: 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 Opsional String (Teks)
frame_text_size Opsional Integer (Angka Bulat) -5 - 5
frame_text_font Opsional String (Teks) Nilai yang diizinkan: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Opsional Boolean (True/False)
frame_color Opsional String (Teks) Tersedia saat: frame_custom_colors = 1
frame_text_color Opsional String (Teks) Tersedia saat: frame_custom_colors = 1
size Opsional Integer (Angka Bulat) 50-2000
margin Opsional Integer (Angka Bulat) 0-25
ecc Opsional String (Teks) Nilai yang diizinkan: L, M, Q, H
text Opsional String (Teks) Tersedia saat: type = text
url Opsional String (Teks) Tersedia saat: type = url
phone Opsional String (Teks) Tersedia saat: type = phone
sms Opsional String (Teks) Tersedia saat: type = sms
sms_body Opsional String (Teks) Tersedia saat: type = sms
email Opsional String (Teks) Tersedia saat: type = email
whatsapp Opsional String (Teks) Tersedia saat: type = whatsapp
whatsapp_body Opsional String (Teks) Tersedia saat: type = whatsapp
facetime Opsional String (Teks) Tersedia saat: type = facetime
location
location_latitude Opsional Float (Desimal) Tersedia saat: type = location
location_longitude Opsional Float (Desimal) Tersedia saat: type = location
wifi
wifi_ssid Opsional String (Teks) Tersedia saat: type = wifi
wifi_encryption Opsional String (Teks) Nilai yang diizinkan: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opsional String (Teks) Tersedia saat: type = wifi
wifi_is_hidden Opsional Boolean (True/False) Tersedia saat: type = wifi
event Opsional String (Teks) Tersedia saat: type = event
event_location Opsional String (Teks) Tersedia saat: type = event
event_url Opsional String (Teks) Tersedia saat: type = event
event_note Opsional String (Teks) Tersedia saat: type = event
event_timezone Opsional String (Teks) Tersedia saat: type = event
event_start_datetime Opsional String (Teks) Tersedia saat: type = event
event_end_datetime Opsional String (Teks) Tersedia saat: type = event
crypto
crypto_coin Opsional String (Teks) Tersedia saat: type = crypto
crypto_address Opsional String (Teks) Tersedia saat: type = crypto
crypto_amount Opsional String (Teks) Tersedia saat: type = crypto
vcard
vcard_first_name Opsional String (Teks) Tersedia saat: type = vcard
vcard_last_name Opsional String (Teks) Tersedia saat: type = vcard
vcard_company Opsional String (Teks) Tersedia saat: type = vcard
vcard_phone_number_label[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_phone_number_value[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_email Opsional String (Teks) Tersedia saat: type = vcard
vcard_url Opsional String (Teks) Tersedia saat: type = vcard
vcard_job_title Opsional String (Teks) Tersedia saat: type = vcard
vcard_birthday Opsional String (Teks) Tersedia saat: type = vcard
vcard_street Opsional String (Teks) Tersedia saat: type = vcard
vcard_city Opsional String (Teks) Tersedia saat: type = vcard
vcard_zip Opsional String (Teks) Tersedia saat: type = vcard
vcard_region Opsional String (Teks) Tersedia saat: type = vcard
vcard_country Opsional String (Teks) Tersedia saat: type = vcard
vcard_note Opsional String (Teks) Tersedia saat: type = vcard
vcard_social_label[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_social_value[index] Opsional String (Teks) Tersedia saat: type = vcard
paypal
paypal_type Opsional String (Teks) Nilai yang diizinkan: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opsional String (Teks) Tersedia saat: type = paypal
paypal_title Opsional String (Teks) Tersedia saat: type = paypal
paypal_currency Opsional String (Teks) Tersedia saat: type = paypal
paypal_price Opsional Float (Desimal) Tersedia saat: type = paypal
paypal_thank_you_url Opsional String (Teks) Tersedia saat: type = paypal
paypal_cancel_url Opsional String (Teks) Tersedia saat: type = paypal
upi
upi_payee_id Opsional String (Teks) Tersedia saat: type = upi
upi_payee_name Opsional String (Teks) Tersedia saat: type = upi
upi_currency Opsional String (Teks) Tersedia saat: type = upi
upi_amount Opsional Float (Desimal) Tersedia saat: type = upi
upi_transaction_id Opsional String (Teks) Tersedia saat: type = upi
upi_transaction_note Opsional String (Teks) Tersedia saat: type = upi
upi_transaction_reference Opsional String (Teks) Tersedia saat: type = upi
upi_thank_you_url Opsional String (Teks) Tersedia saat: type = upi
epc
epc_iban Opsional String (Teks) Tersedia saat: type = epc
epc_payee_name Opsional String (Teks) Tersedia saat: type = epc
epc_currency Opsional String (Teks) Tersedia saat: type = epc
epc_amount Opsional Float (Desimal) Tersedia saat: type = epc
epc_bic Opsional String (Teks) Tersedia saat: type = epc
epc_remittance_reference Opsional String (Teks) Tersedia saat: type = epc
epc_remittance_text Opsional String (Teks) Tersedia saat: type = epc
information Opsional String (Teks) Tersedia saat: type = epc
Parameter Detail Deskripsi
curl --request POST \
--url 'https://xyz.ayo.ke/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://xyz.ayo.ke/api/qr-codes/{qr_code_id}
Parameter Detail Deskripsi
project_id Opsional String (Teks) -
name Opsional String (Teks) -
type Opsional String (Teks) Nilai yang diizinkan: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc
style Opsional String (Teks) Nilai yang diizinkan: square, dot, round, diamond, heart
inner_eye_style Opsional String (Teks) Nilai yang diizinkan: square, dot, rounded, diamond, flower, leaf
outer_eye_style Opsional String (Teks) Nilai yang diizinkan: square, circle, rounded, flower, leaf
foreground_type Opsional String (Teks) Nilai yang diizinkan: color, gradient
foreground_color Opsional String (Teks) Tersedia saat: foreground_type = color
foreground_gradient_style Opsional String (Teks) Nilai yang diizinkan: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Opsional String (Teks) Tersedia saat: foreground_type = gradient
foreground_gradient_two Opsional String (Teks) Tersedia saat: foreground_type = gradient
background_color Opsional String (Teks)
background_color_transparency Opsional Integer (Angka Bulat) 0 - 100
custom_eyes_color Opsional Boolean (True/False)
eyes_inner_color Opsional String (Teks) Tersedia saat: custom_eyes_color = 1
eyes_outer_color Opsional String (Teks) Tersedia saat: custom_eyes_color = 1
qr_code_logo Opsional File -
qr_code_logo_size Opsional Integer (Angka Bulat) 5-35
qr_code_background Opsional File -
qr_code_background_transparency Opsional Integer (Angka Bulat) 0-100
frame Opsional String (Teks) Nilai yang diizinkan: 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 Opsional String (Teks)
frame_text_size Opsional Integer (Angka Bulat) -5 -> 5
frame_text_font Opsional String (Teks) Nilai yang diizinkan: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Opsional Boolean (True/False)
frame_color Opsional String (Teks) Tersedia saat: frame_custom_colors = 1
frame_text_color Opsional String (Teks) Tersedia saat: frame_custom_colors = 1
size Opsional Integer (Angka Bulat) 50-2000
margin Opsional Integer (Angka Bulat) 0-25
ecc Opsional String (Teks) Nilai yang diizinkan: L, M, Q, H
text Opsional String (Teks) Tersedia saat: type = text
url Opsional String (Teks) Tersedia saat: type = url
phone Opsional String (Teks) Tersedia saat: type = phone
sms Opsional String (Teks) Tersedia saat: type = sms
sms_body Opsional String (Teks) Tersedia saat: type = sms
email Opsional String (Teks) Tersedia saat: type = email
whatsapp Opsional String (Teks) Tersedia saat: type = whatsapp
whatsapp_body Opsional String (Teks) Tersedia saat: type = whatsapp
facetime Opsional String (Teks) Tersedia saat: type = facetime
location
location_latitude Opsional Float (Desimal) Tersedia saat: type = location
location_longitude Opsional Float (Desimal) Tersedia saat: type = location
wifi
wifi_ssid Opsional String (Teks) Tersedia saat: type = wifi
wifi_encryption Opsional String (Teks) Nilai yang diizinkan: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Opsional String (Teks) Tersedia saat: type = wifi
wifi_is_hidden Opsional Boolean (True/False) Tersedia saat: type = wifi
event Opsional String (Teks) Tersedia saat: type = event
event_location Opsional String (Teks) Tersedia saat: type = event
event_url Opsional String (Teks) Tersedia saat: type = event
event_note Opsional String (Teks) Tersedia saat: type = event
event_timezone Opsional String (Teks) Tersedia saat: type = event
event_start_datetime Opsional String (Teks) Tersedia saat: type = event
event_end_datetime Opsional String (Teks) Tersedia saat: type = event
crypto
crypto_coin Opsional String (Teks) Tersedia saat: type = crypto
crypto_address Opsional String (Teks) Tersedia saat: type = crypto
crypto_amount Opsional String (Teks) Tersedia saat: type = crypto
vcard
vcard_first_name Opsional String (Teks) Tersedia saat: type = vcard
vcard_last_name Opsional String (Teks) Tersedia saat: type = vcard
vcard_company Opsional String (Teks) Tersedia saat: type = vcard
vcard_phone_number_label[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_phone_number_value[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_email Opsional String (Teks) Tersedia saat: type = vcard
vcard_url Opsional String (Teks) Tersedia saat: type = vcard
vcard_job_title Opsional String (Teks) Tersedia saat: type = vcard
vcard_birthday Opsional String (Teks) Tersedia saat: type = vcard
vcard_street Opsional String (Teks) Tersedia saat: type = vcard
vcard_city Opsional String (Teks) Tersedia saat: type = vcard
vcard_zip Opsional String (Teks) Tersedia saat: type = vcard
vcard_region Opsional String (Teks) Tersedia saat: type = vcard
vcard_country Opsional String (Teks) Tersedia saat: type = vcard
vcard_note Opsional String (Teks) Tersedia saat: type = vcard
vcard_social_label[index] Opsional String (Teks) Tersedia saat: type = vcard
vcard_social_value[index] Opsional String (Teks) Tersedia saat: type = vcard
paypal
paypal_type Opsional String (Teks) Nilai yang diizinkan: buy_now, add_to_cart, donation (type=paypal)
paypal_email Opsional String (Teks) Tersedia saat: type = paypal
paypal_title Opsional String (Teks) Tersedia saat: type = paypal
paypal_currency Opsional String (Teks) Tersedia saat: type = paypal
paypal_price Opsional Float (Desimal) Tersedia saat: type = paypal
paypal_thank_you_url Opsional String (Teks) Tersedia saat: type = paypal
paypal_cancel_url Opsional String (Teks) Tersedia saat: type = paypal
upi
upi_payee_id Opsional String (Teks) Tersedia saat: type = upi
upi_payee_name Opsional String (Teks) Tersedia saat: type = upi
upi_currency Opsional String (Teks) Tersedia saat: type = upi
upi_amount Opsional Float (Desimal) Tersedia saat: type = upi
upi_transaction_id Opsional String (Teks) Tersedia saat: type = upi
upi_transaction_note Opsional String (Teks) Tersedia saat: type = upi
upi_transaction_reference Opsional String (Teks) Tersedia saat: type = upi
upi_thank_you_url Opsional String (Teks) Tersedia saat: type = upi
epc
epc_iban Opsional String (Teks) Tersedia saat: type = epc
epc_payee_name Opsional String (Teks) Tersedia saat: type = epc
epc_currency Opsional String (Teks) Tersedia saat: type = epc
epc_amount Opsional Float (Desimal) Tersedia saat: type = epc
epc_bic Opsional String (Teks) Tersedia saat: type = epc
epc_remittance_reference Opsional String (Teks) Tersedia saat: type = epc
epc_remittance_text Opsional String (Teks) Tersedia saat: type = epc
information Opsional String (Teks) Tersedia saat: type = epc
curl --request POST \
--url 'https://xyz.ayo.ke/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://xyz.ayo.ke/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://xyz.ayo.ke/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \