QR-koodit API-dokumentaatio

Hae kaikki

Päätepiste

GET https://linkki.si/api/qr-codes/

Esimerkki

curl --request GET \
--url 'https://linkki.si/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \

parametrit	Tiedot	Kuvaus
page	Valinnainen Kokonaisluku	Sivunumero, josta haluat tuloksia. Oletusarvo on `1` .
results_per_page	Valinnainen Kokonaisluku	Kuinka monta tulosta haluat sivua kohden. Sallitut arvot ovat: `10` , `25` , `50` , `100` , `250` , `500`. Oletusarvo on `25` .

Esimerkkivastaus

{
    "data": [
        {
            "id": 1,
            "type": "url",
            "name": "Example name",
            "qr_code": "https://linkki.si/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://linkki.si/api/qr-codes?&page=1",
        "last": "https://linkki.si/api/qr-codes?&page=1",
        "next": null,
        "prev": null,
        "self": "https://linkki.si/api/qr-codes?&page=1"
    }
}

Hae yksi

Päätepiste

GET https://linkki.si/api/qr-codes/{qr_code_id}

Esimerkki

curl --request GET \
--url 'https://linkki.si/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

Esimerkkivastaus

{
    "data": {
        "id": 1,
        "type": "url",
        "name": "Example name",
        "qr_code": "https://linkki.si/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"
    }
}

parametrit	Tiedot	Kuvaus
project_id	Valinnainen Kokonaisluku	-
name	Pakollinen String	-
type	Pakollinen String	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
foreground_type	Valinnainen String	`color`, `gradient`
foreground_color	Valinnainen String	(foreground_type=color)
foreground_gradient_style	Valinnainen String	`vertical` `horizontal` `diagonal` `inverse_diagonal` `radial` (foreground_type=gradient)
foreground_gradient_one	Valinnainen String	(foreground_type=gradient)
foreground_gradient_two	Valinnainen String	(foreground_type=gradient)
background_color	Valinnainen String
background_color_transparency	Valinnainen Kokonaisluku
custom_eyes_color	Valinnainen Boolen
eyes_inner_color	Valinnainen String	(custom_eyes_color=1)
eyes_outer_color	Valinnainen String	(custom_eyes_color=1)
qr_code_logo	Valinnainen Tiedosto	-
qr_code_logo_size	Valinnainen Kokonaisluku	5-35
size	Valinnainen Kokonaisluku	50-2000
margin	Valinnainen Kokonaisluku	0-25
ecc	Valinnainen String	`L`, `M`, `Q`, `H`
text	Valinnainen String	(type=text)
url	Valinnainen String	(type=url)
phone	Valinnainen String	(type=phone)
sms	Valinnainen String	(type=sms)
email	Valinnainen String	(type=email)
email_subject	Valinnainen String	(type=email)
email_body	Valinnainen String	(type=email)
whatsapp	Valinnainen String	(type=whatsapp)
facetime	Valinnainen String	(type=facetime)
location_latitude	Valinnainen Kellua	(type=location)
location_longitude	Valinnainen Kellua	(type=location)
wifi_ssid	Valinnainen String	(type=wifi)
wifi_encryption	Valinnainen String	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	Valinnainen String	(type=wifi)
wifi_is_hidden	Valinnainen Boolen	(type=wifi)
event	Valinnainen String	(type=event)
event_location	Valinnainen String	(type=event)
event_url	Valinnainen String	(type=event)
event_note	Valinnainen String	(type=event)
event_timezone	Valinnainen String	(type=event)
event_start_datetime	Valinnainen String	(type=event)
event_end_datetime	Valinnainen String	(type=event)
crypto_coin	Valinnainen String	(type=crypto)
crypto_address	Valinnainen String	(type=crypto)
crypto_amount	Valinnainen String	(type=crypto)
vcard_first_name	Valinnainen String	(type=vcard)
vcard_last_name	Valinnainen String	(type=vcard)
vcard_phone	Valinnainen String	(type=vcard)
vcard_email	Valinnainen String	(type=vcard)
vcard_url	Valinnainen String	(type=vcard)
vcard_job_title	Valinnainen String	(type=vcard)
vcard_birthday	Valinnainen String	(type=vcard)
vcard_street	Valinnainen String	(type=vcard)
vcard_city	Valinnainen String	(type=vcard)
vcard_zip	Valinnainen String	(type=vcard)
vcard_region	Valinnainen String	(type=vcard)
vcard_country	Valinnainen String	(type=vcard)
vcard_note	Valinnainen String	(type=vcard)
vcard_social_label[index]	Valinnainen String	(type=vcard)
vcard_social_value[index]	Valinnainen String	(type=vcard)

curl --request POST \
--url 'https://linkki.si/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

Esimerkkivastaus

{
    "data": {
        "id": 1
    }
}

Päivitä

Päätepiste

POST https://linkki.si/api/qr-codes/{qr_code_id}

parametrit	Tiedot	Kuvaus
project_id	Valinnainen String	-
name	Valinnainen String	-
type	Valinnainen String	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
foreground_type	Valinnainen String	`color`, `gradient`
foreground_color	Valinnainen String	(foreground_type=color)
foreground_gradient_style	Valinnainen String	`vertical` `horizontal` `diagonal` `inverse_diagonal` `radial` (foreground_type=gradient)
foreground_gradient_one	Valinnainen String	(foreground_type=gradient)
foreground_gradient_two	Valinnainen String	(foreground_type=gradient)
background_color	Valinnainen String
background_color_transparency	Valinnainen Kokonaisluku
custom_eyes_color	Valinnainen Boolen
eyes_inner_color	Valinnainen String	(custom_eyes_color=1)
eyes_outer_color	Valinnainen String	(custom_eyes_color=1)
qr_code_logo	Valinnainen Tiedosto	-
qr_code_logo_size	Valinnainen Kokonaisluku	5-35
size	Valinnainen Kokonaisluku	50-2000
margin	Valinnainen Kokonaisluku	0-25
ecc	Valinnainen String	`L`, `M`, `Q`, `H`
text	Valinnainen String	(type=text)
url	Valinnainen String	(type=url)
phone	Valinnainen String	(type=phone)
sms	Valinnainen String	(type=sms)
email	Valinnainen String	(type=email)
email_subject	Valinnainen String	(type=email)
email_body	Valinnainen String	(type=email)
whatsapp	Valinnainen String	(type=whatsapp)
facetime	Valinnainen String	(type=facetime)
location_latitude	Valinnainen Kellua	(type=location)
location_longitude	Valinnainen Kellua	(type=location)
wifi_ssid	Valinnainen String	(type=wifi)
wifi_encryption	Valinnainen String	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	Valinnainen String	(type=wifi)
wifi_is_hidden	Valinnainen Boolen	(type=wifi)
event	Valinnainen String	(type=event)
event_location	Valinnainen String	(type=event)
event_url	Valinnainen String	(type=event)
event_note	Valinnainen String	(type=event)
event_timezone	Valinnainen String	(type=event)
event_start_datetime	Valinnainen String	(type=event)
event_end_datetime	Valinnainen String	(type=event)
crypto_coin	Valinnainen String	(type=crypto)
crypto_address	Valinnainen String	(type=crypto)
crypto_amount	Valinnainen String	(type=crypto)
vcard_first_name	Valinnainen String	(type=vcard)
vcard_last_name	Valinnainen String	(type=vcard)
vcard_phone	Valinnainen String	(type=vcard)
vcard_email	Valinnainen String	(type=vcard)
vcard_url	Valinnainen String	(type=vcard)
vcard_job_title	Valinnainen String	(type=vcard)
vcard_birthday	Valinnainen String	(type=vcard)
vcard_street	Valinnainen String	(type=vcard)
vcard_city	Valinnainen String	(type=vcard)
vcard_zip	Valinnainen String	(type=vcard)
vcard_region	Valinnainen String	(type=vcard)
vcard_country	Valinnainen String	(type=vcard)
vcard_note	Valinnainen String	(type=vcard)
vcard_social_label[index]	Valinnainen String	(type=vcard)
vcard_social_value[index]	Valinnainen String	(type=vcard)

Esimerkki

curl --request POST \
--url 'https://linkki.si/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Esimerkkivastaus

{
  "data": {
    "id": 1
  }
}

Poista

Päätepiste

DELETE https://linkki.si/api/qr-codes/{qr_code_id}

Esimerkki

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

QR-koodit

Hae kaikki

Hae yksi

Luo

Päivitä

Poista