Links

Notas
Nível expert
A chave da API deve ser enviada como token Bearer no cabeçalho Authorization Obter sua chave da API.
Lista

Endpoint da API:

GET 
https://www.xurl.ooo/api/v1/links

Exemplo de requisição: 

curl --location --request GET 'https://www.xurl.ooo/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de pesquisa
search_by
opcional string
Pesquisar por. Valores possíveis: title para Título, alias para Apelido, url para URL Padrão: title
status
opcional integer
Filtrar por status Valores possíveis: 0 para Todos, 1 para Ativo, 2 para Expirado, 3 para Desativado Padrão: 0
space_id
opcional integer
Filtrar por ID do espaço
domain_id
opcional integer
Filtrar por ID do domínio
pixel_id
opcional integer
Filtrar por ID do pixel
sort_by
opcional string
Ordenar por. Valores possíveis: id para Data de criação, clicks para Cliques, title para Título, alias para Apelido, url para URL Padrão: id
sort
opcional string
Ordenar. Valores possíveis: desc para Decrescente, asc para Crescente Padrão: desc
per_page
opcional integer
Resultados por página. Valores possíveis: 10, 25, 50, 100 Padrão: 100
Mostrar

Endpoint da API:

GET 
https://www.xurl.ooo/api/v1/links/{id}

Exemplo de requisição: 

curl --location --request GET 'https://www.xurl.ooo/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Armazenar

Endpoint da API:

POST 
https://www.xurl.ooo/api/v1/links

Exemplo de requisição: 

curl --location --request POST 'https://www.xurl.ooo/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parâmetro
Tipo
Descrição
url
obrigatório string
Link a ser encurtado
domain_id
obrigatório integer
ID do domínio onde o link será salvo
alias
opcional string
Apelido do link
password
opcional string
Senha do link
space_id
opcional integer
ID do espaço onde o link será salvo
pixel_ids
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Se o link está desativado Valores possíveis: 0 para Ativo, 1 para Desativado Padrão: 0
privacy
opcional integer
Se as estatísticas do link são públicas Valores possíveis: 0 para Público, 1 para Privado, 2 para Senha Padrão: 0
privacy_password
opcional string
Senha da página de estatísticas Funciona apenas se privacy estiver definido como 2
expiration_url
opcional string
Link para redirecionamento após expiração
expiration_date
opcional string
Data de expiração do link no formato YYYY-MM-DD
expiration_time
opcional string
Hora de expiração do link no formato HH:MM
expiration_clicks
opcional integer
Número de cliques para expirar o link
target_type
opcional integer
Tipo de segmentação Valores possíveis: 0 para Nenhum, 1 para Geográfico, 2 para Plataforma, 4 para Rotação
country[index][key]
opcional string
Código do país alvo O código deve seguir o padrão ISO 3166-1 alpha-2
country[index][value]
opcional string
Link para redirecionamento
platform[index][key]
opcional string
Nome da plataforma alvo Valores possíveis: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS
platform[index][value]
opcional string
Link para redirecionamento
language[index][key]
opcional string
Código do idioma alvo O código deve seguir o padrão ISO 639-1 alpha-2
language[index][value]
opcional string
Link para redirecionamento
rotation[index][value]
opcional string
Link para redirecionamento
Atualizar

Endpoint da API:

PUT PATCH 
https://www.xurl.ooo/api/v1/links/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://www.xurl.ooo/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parâmetro
Tipo
Descrição
url
opcional string
Link a ser encurtado
alias
opcional string
Apelido do link
password
opcional string
Senha do link
space_id
opcional integer
ID do espaço onde o link será salvo
pixel_ids
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Se o link está desativado Valores possíveis: 0 para Ativo, 1 para Desativado
privacy
opcional integer
Se as estatísticas do link são públicas Valores possíveis: 0 para Público, 1 para Privado, 2 para Senha
privacy_password
opcional string
Senha da página de estatísticas Funciona apenas se privacy estiver definido como 2
expiration_url
opcional string
Link para redirecionamento após expiração
expiration_date
opcional string
Data de expiração do link no formato YYYY-MM-DD
expiration_time
opcional string
Hora de expiração do link no formato HH:MM
expiration_clicks
opcional integer
Número de cliques para expirar o link
target_type
opcional integer
Tipo de segmentação Valores possíveis: 0 para Nenhum, 1 para Geográfico, 2 para Plataforma, 4 para Rotação
country[index][key]
opcional string
Código do país alvo O código deve seguir o padrão ISO 3166-1 alpha-2
country[index][value]
opcional string
Link para redirecionamento
platform[index][key]
opcional string
Nome da plataforma alvo Valores possíveis: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS
platform[index][value]
opcional string
Link para redirecionamento
language[index][key]
opcional string
Código do idioma alvo O código deve seguir o padrão ISO 639-1 alpha-2
language[index][value]
opcional string
Link para redirecionamento
rotation[index][value]
opcional string
Link para redirecionamento
Excluir

Endpoint da API:

DELETE 
https://www.xurl.ooo/api/v1/links/{id}

Exemplo de requisição: 

curl --location --request DELETE 'https://www.xurl.ooo/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'