Länkar - API-dokumentation

Hämta alla

Slutpunkt

GET https://qr-kode.no/api/links/

Exempel

curl --request GET \
--url 'https://qr-kode.no/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parametrar	Detaljer	Beskrivning
page	Valfri Heltal	Sidnumret som du vill ha resultat från. Standardinställningen är `1`
results_per_page	Valfri Heltal	Hur många resultat vill du ha per sida. Tillåtna värden är: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standard är `25`.

Svars exempel

{ "data": [ { "id": 1, "project_id": null, "domain_id": 0, "type": "link", "url": "example", "location_url": "https://example.com/", "settings": { "password": null, "sensitive_content": false }, "clicks": 10, "order": 0, "start_date": null, "end_date": null, "date": "2020-11-15 12:00:00" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://qr-kode.no/api/links?&page=1", "last": "https://qr-kode.no/api/links?&page=1", "next": null, "prev": null, "self": "https://qr-kode.no/api/links?&page=1" } }

Hämta en

Slutpunkt

GET https://qr-kode.no/api/links/{link_id}

Exempel

curl --request GET \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Svars exempel

{ "data": { "id": 1, "project_id": null, "domain_id": 0, "type": "link", "url": "example", "location_url": "https://example.com/", "settings": { "password": null, "sensitive_content": false }, "clicks": 10, "order": 0, "start_date": null, "end_date": null, "date": "2020-11-15 12:00:00" } }

Skapa

Slutpunkt

POST https://qr-kode.no/api/links

Parametrar	Detaljer	Beskrivning
type	Valfri Sträng	`link`
location_url	Krävs Sträng	URL:en för destinationen
url	Valfri Sträng	URL-alias för den genererade länken. Lämna tomt för en slumpmässigt genererad
domain_id	Valfri Heltal	-
project_id	Valfri Heltal	-
pixels_ids	Valfri Array Heltal	-
schedule	Valfri Boolesk	-
start_date	Valfri Sträng	Available when: schedule = true
end_date	Valfri Sträng	Available when: schedule = true
clicks_limit	Valfri Heltal	-
expiration_url	Valfri Sträng	-
sensitive_content	Valfri Boolesk	-
http_status_code	Valfri Heltal	Tillåtna värden: `301`, `302`, `307`, `308`
app_linking_is_enabled	Valfri Boolesk	-
cloaking_is_enabled	Valfri Boolesk	-
cloaking_title	Valfri Sträng	-
cloaking_favicon	Valfri Fil	-
cloaking_opengraph	Valfri Fil	-
password	Valfri Sträng	-
forward_query_parameters_is_enabled	Valfri Boolesk	-
utm_source	Valfri missing_translation: api_documentation.strings	-
utm_medium	Valfri missing_translation: api_documentation.strings	-
utm_campaign	Valfri missing_translation: api_documentation.strings	-
targeting_type	Valfri Sträng	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Valfri Sträng	(targeting_type=continent_code)
targeting_continent_code_value[index]	Valfri Sträng	(targeting_type=continent_code)
targeting_country_code_key[index]	Valfri Sträng	(targeting_type=country_code)
targeting_country_code_value[index]	Valfri Sträng	(targeting_type=country_code)
targeting_city_name_key[index]	Valfri Sträng	(targeting_type=city_name)
targeting_city_name_value[index]	Valfri Sträng	(targeting_type=city_name)
targeting_device_type_key[index]	Valfri Sträng	(targeting_type=device_type)
targeting_device_type_value[index]	Valfri Sträng	(targeting_type=device_type)
targeting_browser_language_key[index]	Valfri Sträng	(targeting_type=browser_language)
targeting_browser_language_value[index]	Valfri Sträng	(targeting_type=browser_language)
targeting_rotation_key[index]	Valfri Sträng	(targeting_type=rotation)
targeting_rotation_value[index]	Valfri Sträng	(targeting_type=rotation)
targeting_os_name_key[index]	Valfri Sträng	(targeting_type=os_name)
targeting_os_name_value[index]	Valfri Sträng	(targeting_type=os_name)
targeting_browser_name_key[index]	Valfri Sträng	(targeting_type=browser_name)
targeting_browser_name_value[index]	Valfri Sträng	(targeting_type=browser_name)

Exempel

curl --request POST \
--url 'https://qr-kode.no/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://qr-kode.no/' \

Svars exempel

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

Uppdatera

Slutpunkt

POST https://qr-kode.no/api/links/{link_id}

Parametrar	Detaljer	Beskrivning
location_url	Valfri Sträng	URL:en för destinationen
url	Valfri Sträng	URL-alias för den genererade länken. Lämna tomt för en slumpmässigt genererad
domain_id	Valfri Heltal	-
project_id	Valfri Heltal	-
pixels_ids	Valfri Array Heltal	-
schedule	Valfri Boolesk	-
start_date	Valfri Sträng	Available when: schedule = true
end_date	Valfri Sträng	Available when: schedule = true
clicks_limit	Valfri Heltal	-
expiration_url	Valfri Sträng	-
sensitive_content	Valfri Boolesk	-
http_status_code	Valfri Heltal	Tillåtna värden: `301`, `302`, `307`, `308`
app_linking_is_enabled	Valfri Boolesk	-
cloaking_is_enabled	Valfri Boolesk	-
cloaking_title	Valfri Sträng	-
cloaking_favicon	Valfri Fil	-
cloaking_opengraph	Valfri Fil	-
password	Valfri Sträng	-
forward_query_parameters_is_enabled	Valfri Boolesk	-
utm_source	Valfri missing_translation: api_documentation.strings	-
utm_medium	Valfri missing_translation: api_documentation.strings	-
utm_campaign	Valfri missing_translation: api_documentation.strings	-
targeting_type	Valfri Sträng	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Valfri Sträng	(targeting_type=continent_code)
targeting_continent_code_value[index]	Valfri Sträng	(targeting_type=continent_code)
targeting_country_code_key[index]	Valfri Sträng	(targeting_type=country_code)
targeting_country_code_value[index]	Valfri Sträng	(targeting_type=country_code)
targeting_city_name_key[index]	Valfri Sträng	(targeting_type=city_name)
targeting_city_name_value[index]	Valfri Sträng	(targeting_type=city_name)
targeting_device_type_key[index]	Valfri Sträng	(targeting_type=device_type)
targeting_device_type_value[index]	Valfri Sträng	(targeting_type=device_type)
targeting_browser_language_key[index]	Valfri Sträng	(targeting_type=browser_language)
targeting_browser_language_value[index]	Valfri Sträng	(targeting_type=browser_language)
targeting_rotation_key[index]	Valfri Sträng	(targeting_type=rotation)
targeting_rotation_value[index]	Valfri Sträng	(targeting_type=rotation)
targeting_os_name_key[index]	Valfri Sträng	(targeting_type=os_name)
targeting_os_name_value[index]	Valfri Sträng	(targeting_type=os_name)
targeting_browser_name_key[index]	Valfri Sträng	(targeting_type=browser_name)
targeting_browser_name_value[index]	Valfri Sträng	(targeting_type=browser_name)

Exempel

curl --request POST \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Svars exempel

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

Radera

Slutpunkt

DELETE https://qr-kode.no/api/links/{link_id}

Exempel

curl --request DELETE \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \