Links

Listar todos

Endpoint

GET https://virt.cards/api/links/

Exemplo

curl --request GET \
--url 'https://virt.cards/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parâmetros	Detalhes	Descrição
page	Opcional Inteiro	O número da página da qual você quer resultados. Padrão é `1`.
results_per_page	Opcional Inteiro	Quantos resultados por página você deseja. Valores permitidos: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Padrão é `25`.

Exemplo de resposta

{
    "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,
            "datetime": "2025-09-13 17:54:08",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://virt.cards/api/links?page=1",
        "last": "https://virt.cards/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://virt.cards/api/links?page=1"
    }
}

Listar um

Endpoint

GET https://virt.cards/api/links/{link_id}

Exemplo

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

Exemplo de resposta

{
    "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,
        "datetime": "2025-09-13 17:54:08",
    }
}

Parâmetros	Detalhes	Descrição
type	Opcional String	`link`
location_url	Obrigatório String	A URL de destino.Disponível quando: is_bulk = 0
location_urls	Obrigatório String	A URL de destino.Disponível quando: is_bulk = 1
url	Opcional String	O alias da URL do link gerado. Deixe vazio para um gerado aleatoriamente.Disponível quando: is_bulk = 0
is_bulk	Opcional Booleano
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Array Inteiro	-
email_reports	Opcional Array	IDs de handlers de notificação
schedule	Opcional Booleano	-
start_date	Opcional String	Disponível quando: schedule = true
end_date	Opcional String	Disponível quando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional String	-
sensitive_content	Opcional Booleano	-
http_status_code	Opcional Inteiro	Valores permitidos: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opcional Booleano	-
cloaking_is_enabled	Opcional Booleano	-
cloaking_title	Opcional String	-
cloaking_meta_description	Opcional String	-
cloaking_custom_js	Opcional String	-
cloaking_favicon	Opcional Arquivo	-
cloaking_opengraph	Opcional Arquivo	-
password	Opcional String	-
forward_query_parameters_is_enabled	Opcional Booleano	-
utm_source	Opcional String	-
utm_medium	Opcional String	-
utm_campaign	Opcional String	-
targeting_type	Opcional String	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Opcional String	Disponível quando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional String	Disponível quando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional String	Disponível quando: targeting_type = country_code
targeting_country_code_value[index]	Opcional String	Disponível quando: targeting_type = country_code
targeting_city_name_key[index]	Opcional String	Disponível quando: targeting_type = city_name
targeting_city_name_value[index]	Opcional String	Disponível quando: targeting_type = city_name
targeting_device_type_key[index]	Opcional String	Disponível quando: targeting_type = device_type
targeting_device_type_value[index]	Opcional String	Disponível quando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional String	Disponível quando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional String	Disponível quando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional String	Disponível quando: targeting_type = rotation
targeting_rotation_value[index]	Opcional String	Disponível quando: targeting_type = rotation
targeting_os_name_key[index]	Opcional String	Disponível quando: targeting_type = os_name
targeting_os_name_value[index]	Opcional String	Disponível quando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional String	Disponível quando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional String	Disponível quando: targeting_type = browser_name

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

Exemplo de resposta

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

Atualizar

Endpoint

POST https://virt.cards/api/links/{link_id}

Parâmetros	Detalhes	Descrição
location_url	Opcional String	A URL de destino.
url	Opcional String	O alias da URL do link gerado. Deixe vazio para um gerado aleatoriamente.
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Array Inteiro	-
email_reports	Opcional Array	IDs de handlers de notificação
schedule	Opcional Booleano	-
start_date	Opcional String	Disponível quando: schedule = true
end_date	Opcional String	Disponível quando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional String	-
sensitive_content	Opcional Booleano	-
http_status_code	Opcional Inteiro	Valores permitidos: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opcional Booleano	-
cloaking_is_enabled	Opcional Booleano	-
cloaking_title	Opcional String	-
cloaking_meta_description	Opcional String	-
cloaking_custom_js	Opcional String	-
cloaking_favicon	Opcional Arquivo	-
cloaking_opengraph	Opcional Arquivo	-
password	Opcional String	-
forward_query_parameters_is_enabled	Opcional Booleano	-
utm_source	Opcional String	-
utm_medium	Opcional String	-
utm_campaign	Opcional String	-
targeting_type	Opcional String	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Opcional String	Disponível quando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional String	Disponível quando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional String	Disponível quando: targeting_type = country_code
targeting_country_code_value[index]	Opcional String	Disponível quando: targeting_type = country_code
targeting_city_name_key[index]	Opcional String	Disponível quando: targeting_type = city_name
targeting_city_name_value[index]	Opcional String	Disponível quando: targeting_type = city_name
targeting_device_type_key[index]	Opcional String	Disponível quando: targeting_type = device_type
targeting_device_type_value[index]	Opcional String	Disponível quando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional String	Disponível quando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional String	Disponível quando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional String	Disponível quando: targeting_type = rotation
targeting_rotation_value[index]	Opcional String	Disponível quando: targeting_type = rotation
targeting_os_name_key[index]	Opcional String	Disponível quando: targeting_type = os_name
targeting_os_name_value[index]	Opcional String	Disponível quando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional String	Disponível quando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional String	Disponível quando: targeting_type = browser_name

Exemplo

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

Exemplo de resposta

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

Excluir

Endpoint

DELETE https://virt.cards/api/links/{link_id}

Exemplo

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

Links

Listar todos

Listar um

Criar

Atualizar

Excluir