Links

Notas
Nível de especialista
A chave da API deve ser enviada como um token Bearer no cabeçalho de autorização da solicitação. Obtenha sua chave API.
Listar

Ponto de extremidade da API:

GET 
https://veol.ink/api/v1/links

Exemplo de solicitação: 

curl --location --request GET 'https://veol.ink/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
A consulta de pesquisa.
search_by
opcional string
Buscar por. Valores possíveis são: title para Título, alias para Apelido, url para URL. Padrão: title.
status
opcional integer
Filtrar por status. Valores possíveis são: 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 são: 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 são: desc para Decrescente, asc para Crescente. Padrão: desc.
per_page
opcional integer
Resultados por página. Valores possíveis são: 10, 25, 50, 100. Padrão: 10.
Mostrar

Ponto de extremidade da API:

GET 
https://veol.ink/api/v1/links/{id}

Exemplo de solicitação: 

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

Ponto de extremidade da API:

POST 
https://veol.ink/api/v1/links

Exemplo de solicitação: 

curl --location --request POST 'https://veol.ink/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
O link a ser encurtado.
domain_id
obrigatório integer
O ID do domínio onde o link será salvo.
alias
opcional string
O alias do link.
password
opcional string
A senha do link.
space_id
opcional integer
O 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 ou não. Valores possíveis são: 0 para Ativo, 1 para Desativado. Padrão: 0.
privacy
opcional integer
Se as estatísticas do link são públicas ou não. Valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha. Padrão: 0.
privacy_password
opcional string
A senha para a página de estatísticas. Funciona apenas com privacy definido como 2.
expiration_url
opcional string
O link para o qual o usuário será redirecionado após o link expirar.
expiration_date
opcional string
A data de expiração do link no formato YYYY-MM-DD.
expiration_time
opcional string
O horário de expiração do link no formato HH:MM.
expiration_clicks
opcional integer
O número de cliques após os quais o link deve expirar.
target_type
opcional integer
O tipo de segmentação. Valores possíveis são: 0 para Nenhum, 1 para Geographic, 2 para Platform, 4 para Rotation.
country[index][key]
opcional string
O código do país-alvo. O código deve estar no padrão ISO 3166-1 alpha-2.
country[index][value]
opcional string
O link para onde o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma-alvo. Valores possíveis são: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
O link para onde o usuário será redirecionado.
language[index][key]
opcional string
O código do idioma-alvo. O código deve estar no padrão ISO 639-1 alpha-2.
language[index][value]
opcional string
O link para onde o usuário será redirecionado.
rotation[index][value]
opcional string
O link para onde o usuário será redirecionado.
Atualizar

Ponto de extremidade da API:

PUT PATCH 
https://veol.ink/api/v1/links/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://veol.ink/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
O link a ser encurtado.
alias
opcional string
O alias do link.
password
opcional string
A senha do link.
space_id
opcional integer
O 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 ou não. Valores possíveis são: 0 para Ativo, 1 para Desativado.
privacy
opcional integer
Se as estatísticas do link são públicas ou não. Valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha.
privacy_password
opcional string
A senha para a página de estatísticas. Funciona apenas com privacy definido como 2.
expiration_url
opcional string
O link para o qual o usuário será redirecionado após o link expirar.
expiration_date
opcional string
A data de expiração do link no formato YYYY-MM-DD.
expiration_time
opcional string
O horário de expiração do link no formato HH:MM.
expiration_clicks
opcional integer
O número de cliques após os quais o link deve expirar.
target_type
opcional integer
O tipo de segmentação. Valores possíveis são: 0 para Nenhum, 1 para Geographic, 2 para Platform, 4 para Rotation.
country[index][key]
opcional string
O código do país-alvo. O código deve estar no padrão ISO 3166-1 alpha-2.
country[index][value]
opcional string
O link para onde o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma-alvo. Valores possíveis são: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
O link para onde o usuário será redirecionado.
language[index][key]
opcional string
O código do idioma-alvo. O código deve estar no padrão ISO 639-1 alpha-2.
language[index][value]
opcional string
O link para onde o usuário será redirecionado.
rotation[index][value]
opcional string
O link para onde o usuário será redirecionado.
Excluir

Ponto de extremidade da API:

DELETE 
https://veol.ink/api/v1/links/{id}

Exemplo de solicitação: 

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