Enlaces

Recuperar todos

Ponto final

GET https://link.joyproject.com.br/api/links/

Ejemplo

curl --request GET \
--url 'https://link.joyproject.com.br/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parámetros	Detalles	Descripción
search	Opcional Cadeia	A string de pesquisa.
search_by	Opcional Cadeia	Por qual campo estás pesquisando. Los valores permitidos son: `url`, `location_url`.
is_enabled	Opcional Boolean
project_id	Opcional Inteiro
domain_id	Opcional Inteiro
type	Opcional Cadeia	`biolink`, `link`, `file`, `vcard`, `event`, `static`
datetime_field	Opcional Cadeia	Valores permitidos: `datetime`, `last_datetime`
datetime_start	Opcional Cadeia	Filtre los resultados a partir desta fecha y hora. Formato `Y-m-d H:i:s`.
datetime_end	Opcional Cadeia	Filtre los resultados hasta esta fecha y hora. Formato `Y-m-d H:i:s`.
order_by	Opcional Cadeia	Por qual campo ordenar los resultados. Los valores permitidos son: `link_id`, `datetime`, `last_datetime`, `clicks`, `url`.
order_type	Opcional Cadeia	A ordenação de los resultados. Los valores permitidos son: `ASC` para ordenação ascendente y `DESC` para ordenação descendente.
page	Opcional Inteiro	O número de la página que deseas resultados. O predeterminado es `1`.
results_per_page	Opcional Inteiro	Quantos resultados deseas por página. Los valores permitidos son: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. O predeterminado es `25`.

Ejemplo de respuesta

{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "project_id": 1,
            "domain_id": 1,
            "pixels_ids": [],
            "email_reports": [],
            "biolink_theme_id": 1,
            "type": "Example",
            "url": "https://example.com/",
            "location_url": "https://example.com/",
            "settings": [],
            "clicks": 1,
            "start_date": "Example",
            "end_date": "Example",
            "is_verified": true,
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-11-06 22:16:19"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://link.joyproject.com.br/api/links?page=1",
        "last": "https://link.joyproject.com.br/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://link.joyproject.com.br/api/links?page=1"
    }
}

Recuperar un

Ponto final

GET https://link.joyproject.com.br/api/links/{link_id}

Ejemplo

curl --request GET \
--url 'https://link.joyproject.com.br/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Ejemplo de respuesta

{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 1,
        "domain_id": 1,
        "pixels_ids": [],
        "email_reports": [],
        "biolink_theme_id": 1,
        "type": "Example",
        "url": "https://example.com/",
        "location_url": "https://example.com/",
        "settings": [],
        "clicks": 1,
        "start_date": "Example",
        "end_date": "Example",
        "is_verified": true,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-11-06 22:16:19"
    }
}

Parámetros	Detalles	Descripción
type	Opcional Cadeia	`link`
location_url	Obligatorio Cadeia	La URL del destino.Disponible cuando: is_bulk = 0
location_urls	Obligatorio Cadeia	La URL del destino.Disponible cuando: is_bulk = 1
url	Opcional Cadeia	O alias del URL del enlace generado. Deja vacío para un generado aleatoriamente.Disponible cuando: is_bulk = 0
is_bulk	Opcional Boolean
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
email_reports	Opcional Matriz	Identificadores de manejador de notificaciones
schedule	Opcional Boolean	-
start_date	Opcional Cadeia	Disponible cuando: schedule = true
end_date	Opcional Cadeia	Disponible cuando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional Cadeia	-
sensitive_content	Opcional Boolean	-
http_status_code	Opcional Inteiro	Valores permitidos: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opcional Boolean	-
cloaking_is_enabled	Opcional Boolean	-
cloaking_title	Opcional Cadeia	-
cloaking_meta_description	Opcional Cadeia	-
cloaking_custom_js	Opcional Cadeia	-
cloaking_favicon	Opcional Archivo	-
cloaking_opengraph	Opcional Archivo	-
password	Opcional Cadeia	-
forward_query_parameters_is_enabled	Opcional Boolean	-
seo_block	Opcional Boolean	-
utm_source	Opcional Cadeia	-
utm_medium	Opcional Cadeia	-
utm_campaign	Opcional Cadeia	-
targeting_type	Opcional Cadeia	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = country_code
targeting_country_code_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = country_code
targeting_city_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = city_name
targeting_city_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = city_name
targeting_device_type_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = device_type
targeting_device_type_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = rotation
targeting_rotation_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = rotation
targeting_os_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = os_name
targeting_os_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_name
is_enabled	Opcional Boolean	-

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

Ejemplo de respuesta

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

Actualizar

Ponto final

POST https://link.joyproject.com.br/api/links/{link_id}

Parámetros	Detalles	Descripción
location_url	Opcional Cadeia	La URL del destino.
url	Opcional Cadeia	O alias del URL del enlace generado. Deja vacío para un generado aleatoriamente.
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
email_reports	Opcional Matriz	Identificadores de manejador de notificaciones
schedule	Opcional Boolean	-
start_date	Opcional Cadeia	Disponible cuando: schedule = true
end_date	Opcional Cadeia	Disponible cuando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional Cadeia	-
sensitive_content	Opcional Boolean	-
http_status_code	Opcional Inteiro	Valores permitidos: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opcional Boolean	-
cloaking_is_enabled	Opcional Boolean	-
cloaking_title	Opcional Cadeia	-
cloaking_meta_description	Opcional Cadeia	-
cloaking_custom_js	Opcional Cadeia	-
cloaking_favicon	Opcional Archivo	-
cloaking_opengraph	Opcional Archivo	-
password	Opcional Cadeia	-
forward_query_parameters_is_enabled	Opcional Boolean	-
seo_block	Opcional Boolean	-
utm_source	Opcional Cadeia	-
utm_medium	Opcional Cadeia	-
utm_campaign	Opcional Cadeia	-
targeting_type	Opcional Cadeia	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = country_code
targeting_country_code_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = country_code
targeting_city_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = city_name
targeting_city_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = city_name
targeting_device_type_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = device_type
targeting_device_type_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = rotation
targeting_rotation_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = rotation
targeting_os_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = os_name
targeting_os_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional Cadeia	Disponible cuando: targeting_type = browser_name
is_enabled	Opcional Boolean	-
link_id	Opcional Inteiro	-

Ejemplo

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

Ejemplo de respuesta

{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 1,
        "domain_id": 1,
        "pixels_ids": [],
        "email_reports": [],
        "biolink_theme_id": 1,
        "type": "Example",
        "url": "https://example.com/",
        "location_url": "https://example.com/",
        "settings": [],
        "clicks": 1,
        "start_date": "Example",
        "end_date": "Example",
        "is_verified": 1,
        "is_enabled": 1,
        "last_datetime": null,
        "datetime": "2026-11-06 22:16:19"
    }
}

Eliminar

Ponto final

DELETE https://link.joyproject.com.br/api/links/{link_id}

Ejemplo

curl --request DELETE \
--url 'https://link.joyproject.com.br/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Enlaces

Recuperar todos

Recuperar un

Crear

Actualizar

Eliminar