QR-коды

Получить все

Конечная точка

GET https://biolink.ma/api/qr-codes/

Пример

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

Параметры	Подробности	Описание
page	По желанию Целое число	Номер страницы, с которой вы хотите получить результаты. По умолчанию `1`.
results_per_page	По желанию Целое число	Сколько результатов вы хотите на странице. Допустимые значения: `10` , `25` , `50` , `100` , `250` , `500`. По умолчанию `25`.

Пример ответа

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

Получить один

Конечная точка

GET https://biolink.ma/api/qr-codes/{qr_code_id}

Пример

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

Пример ответа

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

Параметры	Подробности	Описание
project_id	По желанию Целое число	-
name	Необходимый Нить	-
type	Необходимый Нить	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
style	По желанию Нить	`square`, `dot`, `round`
foreground_type	По желанию Нить	`color`, `gradient`
foreground_color	По желанию Нить	(foreground_type=color)
foreground_gradient_style	По желанию Нить	`vertical` `horizontal` `diagonal` `inverse_diagonal` `radial` (foreground_type=gradient)
foreground_gradient_one	По желанию Нить	(foreground_type=gradient)
foreground_gradient_two	По желанию Нить	(foreground_type=gradient)
background_color	По желанию Нить
background_color_transparency	По желанию Целое число
custom_eyes_color	По желанию Логический
eyes_inner_color	По желанию Нить	(custom_eyes_color=1)
eyes_outer_color	По желанию Нить	(custom_eyes_color=1)
qr_code_logo	По желанию Файл	-
qr_code_logo_size	По желанию Целое число	5-35
size	По желанию Целое число	50-2000
margin	По желанию Целое число	0-25
ecc	По желанию Нить	`L`, `M`, `Q`, `H`
text	По желанию Нить	(type=text)
url	По желанию Нить	(type=url)
phone	По желанию Нить	(type=phone)
sms	По желанию Нить	(type=sms)
sms_body	По желанию Нить	(type=sms)
email	По желанию Нить	(type=email)
email_subject	По желанию Нить	(type=email)
email_body	По желанию Нить	(type=email)
whatsapp	По желанию Нить	(type=whatsapp)
whatsapp_body	По желанию Нить	(type=whatsapp)
facetime	По желанию Нить	(type=facetime)
location_latitude	По желанию Плавать	(type=location)
location_longitude	По желанию Плавать	(type=location)
wifi_ssid	По желанию Нить	(type=wifi)
wifi_encryption	По желанию Нить	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	По желанию Нить	(type=wifi)
wifi_is_hidden	По желанию Логический	(type=wifi)
event	По желанию Нить	(type=event)
event_location	По желанию Нить	(type=event)
event_url	По желанию Нить	(type=event)
event_note	По желанию Нить	(type=event)
event_timezone	По желанию Нить	(type=event)
event_start_datetime	По желанию Нить	(type=event)
event_end_datetime	По желанию Нить	(type=event)
crypto_coin	По желанию Нить	(type=crypto)
crypto_address	По желанию Нить	(type=crypto)
crypto_amount	По желанию Нить	(type=crypto)
vcard_first_name	По желанию Нить	(type=vcard)
vcard_last_name	По желанию Нить	(type=vcard)
vcard_company	По желанию Нить	(type=vcard)
vcard_phone	По желанию Нить	(type=vcard)
vcard_email	По желанию Нить	(type=vcard)
vcard_url	По желанию Нить	(type=vcard)
vcard_job_title	По желанию Нить	(type=vcard)
vcard_birthday	По желанию Нить	(type=vcard)
vcard_street	По желанию Нить	(type=vcard)
vcard_city	По желанию Нить	(type=vcard)
vcard_zip	По желанию Нить	(type=vcard)
vcard_region	По желанию Нить	(type=vcard)
vcard_country	По желанию Нить	(type=vcard)
vcard_note	По желанию Нить	(type=vcard)
vcard_social_label[index]	По желанию Нить	(type=vcard)
vcard_social_value[index]	По желанию Нить	(type=vcard)

curl --request POST \
--url 'https://biolink.ma/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://biolink.ma/api/qr-codes/{qr_code_id}

Параметры	Подробности	Описание
project_id	По желанию Нить	-
name	По желанию Нить	-
type	По желанию Нить	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
style	По желанию Нить	`square`, `dot`, `round`
foreground_type	По желанию Нить	`color`, `gradient`
foreground_color	По желанию Нить	(foreground_type=color)
foreground_gradient_style	По желанию Нить	`vertical` `horizontal` `diagonal` `inverse_diagonal` `radial` (foreground_type=gradient)
foreground_gradient_one	По желанию Нить	(foreground_type=gradient)
foreground_gradient_two	По желанию Нить	(foreground_type=gradient)
background_color	По желанию Нить
background_color_transparency	По желанию Целое число
custom_eyes_color	По желанию Логический
eyes_inner_color	По желанию Нить	(custom_eyes_color=1)
eyes_outer_color	По желанию Нить	(custom_eyes_color=1)
qr_code_logo	По желанию Файл	-
qr_code_logo_size	По желанию Целое число	5-35
size	По желанию Целое число	50-2000
margin	По желанию Целое число	0-25
ecc	По желанию Нить	`L`, `M`, `Q`, `H`
text	По желанию Нить	(type=text)
url	По желанию Нить	(type=url)
phone	По желанию Нить	(type=phone)
sms	По желанию Нить	(type=sms)
sms_body	По желанию Нить	(type=sms)
email	По желанию Нить	(type=email)
email_subject	По желанию Нить	(type=email)
email_body	По желанию Нить	(type=email)
whatsapp	По желанию Нить	(type=whatsapp)
whatsapp_body	По желанию Нить	(type=whatsapp)
facetime	По желанию Нить	(type=facetime)
location_latitude	По желанию Плавать	(type=location)
location_longitude	По желанию Плавать	(type=location)
wifi_ssid	По желанию Нить	(type=wifi)
wifi_encryption	По желанию Нить	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	По желанию Нить	(type=wifi)
wifi_is_hidden	По желанию Логический	(type=wifi)
event	По желанию Нить	(type=event)
event_location	По желанию Нить	(type=event)
event_url	По желанию Нить	(type=event)
event_note	По желанию Нить	(type=event)
event_timezone	По желанию Нить	(type=event)
event_start_datetime	По желанию Нить	(type=event)
event_end_datetime	По желанию Нить	(type=event)
crypto_coin	По желанию Нить	(type=crypto)
crypto_address	По желанию Нить	(type=crypto)
crypto_amount	По желанию Нить	(type=crypto)
vcard_first_name	По желанию Нить	(type=vcard)
vcard_last_name	По желанию Нить	(type=vcard)
vcard_company	По желанию Нить	(type=vcard)
vcard_phone	По желанию Нить	(type=vcard)
vcard_email	По желанию Нить	(type=vcard)
vcard_url	По желанию Нить	(type=vcard)
vcard_job_title	По желанию Нить	(type=vcard)
vcard_birthday	По желанию Нить	(type=vcard)
vcard_street	По желанию Нить	(type=vcard)
vcard_city	По желанию Нить	(type=vcard)
vcard_zip	По желанию Нить	(type=vcard)
vcard_region	По желанию Нить	(type=vcard)
vcard_country	По желанию Нить	(type=vcard)
vcard_note	По желанию Нить	(type=vcard)
vcard_social_label[index]	По желанию Нить	(type=vcard)
vcard_social_value[index]	По желанию Нить	(type=vcard)

Пример

curl --request POST \
--url 'https://biolink.ma/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://biolink.ma/api/qr-codes/{qr_code_id}

Пример

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

QR-коды

Получить все

Получить один

Создавать

Обновлять

Удалить