Links

Recupere todos

Ponto final de acesso

GET https://encurtaja.com/api/links/

Exemplo

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

Parâmetros	Detalhes	Descrição
page	Opcional Inteiro	O número da página do qual você deseja obter resultados. O padrão é `1`
results_per_page	Opcional Inteiro	Quantos resultados você deseja por página. Os valores permitidos são: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. O 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-06-10 06:36:52" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://encurtaja.com/api/links?&page=1", "last": "https://encurtaja.com/api/links?&page=1", "next": null, "prev": null, "self": "https://encurtaja.com/api/links?&page=1" } }

Recupere um

Ponto final de acesso

GET https://encurtaja.com/api/links/{link_id}

Exemplo

curl --request GET \
--url 'https://encurtaja.com/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-06-10 06:36:52" } }

Parâmetros	Detalhes	Descrição
type	Opcional Tradução, mas evite retornar pontos finais: String	`link`
location_url	Obrigatório Tradução, mas evite retornar pontos finais: String	A URL do destinoDisponível quando: is_bulk = 0
location_urls	Obrigatório Tradução, mas evite retornar pontos finais: String	A URL do destinoDisponível quando: is_bulk = 1
url	Opcional Tradução, mas evite retornar pontos finais: String	O apelido da URL do link gerado. Deixe em branco para uma geração aleatóriaDisponível quando: is_bulk = 0
is_bulk	Opcional Booleano
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
schedule	Opcional Booleano	-
start_date	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: schedule = true
end_date	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional Tradução, mas evite retornar pontos finais: 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 Tradução, mas evite retornar pontos finais: String	-
cloaking_meta_description	Opcional Tradução, mas evite retornar pontos finais: String	-
cloaking_custom_js	Opcional Tradução, mas evite retornar pontos finais: String	-
cloaking_favicon	Opcional Arquivo	-
cloaking_opengraph	Opcional Arquivo	-
password	Opcional Tradução, mas evite retornar pontos finais: String	-
forward_query_parameters_is_enabled	Opcional Booleano	-
utm_source	Opcional Tradução, mas evite retornar pontos finais: String	-
utm_medium	Opcional Tradução, mas evite retornar pontos finais: String	-
utm_campaign	Opcional Tradução, mas evite retornar pontos finais: String	-
targeting_type	Opcional Tradução, mas evite retornar pontos finais: String	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = country_code
targeting_country_code_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = country_code
targeting_city_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = city_name
targeting_city_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = city_name
targeting_device_type_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = device_type
targeting_device_type_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = rotation
targeting_rotation_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = rotation
targeting_os_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = os_name
targeting_os_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_name

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

Exemplo de resposta

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

Atualização

Ponto final de acesso

POST https://encurtaja.com/api/links/{link_id}

Parâmetros	Detalhes	Descrição
location_url	Opcional Tradução, mas evite retornar pontos finais: String	A URL do destino
url	Opcional Tradução, mas evite retornar pontos finais: String	O apelido da URL do link gerado. Deixe em branco para uma geração aleatória
domain_id	Opcional Inteiro	-
project_id	Opcional Inteiro	-
pixels_ids	Opcional Matriz Inteiro	-
schedule	Opcional Booleano	-
start_date	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: schedule = true
end_date	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: schedule = true
clicks_limit	Opcional Inteiro	-
expiration_url	Opcional Tradução, mas evite retornar pontos finais: 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 Tradução, mas evite retornar pontos finais: String	-
cloaking_meta_description	Opcional Tradução, mas evite retornar pontos finais: String	-
cloaking_custom_js	Opcional Tradução, mas evite retornar pontos finais: String	-
cloaking_favicon	Opcional Arquivo	-
cloaking_opengraph	Opcional Arquivo	-
password	Opcional Tradução, mas evite retornar pontos finais: String	-
forward_query_parameters_is_enabled	Opcional Booleano	-
utm_source	Opcional Tradução, mas evite retornar pontos finais: String	-
utm_medium	Opcional Tradução, mas evite retornar pontos finais: String	-
utm_campaign	Opcional Tradução, mas evite retornar pontos finais: String	-
targeting_type	Opcional Tradução, mas evite retornar pontos finais: String	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = continent_code
targeting_continent_code_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = continent_code
targeting_country_code_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = country_code
targeting_country_code_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = country_code
targeting_city_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = city_name
targeting_city_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = city_name
targeting_device_type_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = device_type
targeting_device_type_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = device_type
targeting_browser_language_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_language
targeting_browser_language_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_language
targeting_rotation_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = rotation
targeting_rotation_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = rotation
targeting_os_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = os_name
targeting_os_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = os_name
targeting_browser_name_key[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_name
targeting_browser_name_value[index]	Opcional Tradução, mas evite retornar pontos finais: String	Disponível quando: targeting_type = browser_name

Exemplo

curl --request POST \
--url 'https://encurtaja.com/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

Ponto final de acesso

DELETE https://encurtaja.com/api/links/{link_id}

Exemplo

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

Links

Recupere todos

Recupere um

Criar

Atualização

Excluir