Links

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

Ponto de extremidade da API:

GET 
https://yours.com.br/api/v1/links

Exemplo de solicitação: 

curl --location --request GET 'https://yours.com.br/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. Os valores possíveis são: title para Título, alias para Alias, url para URL. O padrão é: title.
status
opcional integer
Status. Os valores possíveis são: 0 para Todos, 1 para Ativo, 2 para Expirado, 3 para Desabilitado. O padrão é: 0.
space_id
opcional integer
ID do espaço.
domain_id
opcional integer
ID do domínio.
pixel_id
opcional integer
ID do pixel.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, clicks para Cliques, title para Título, alias para Alias, url para URL. O padrão é: id.
sort
opcional string
Organizar. Os valores possíveis são: desc para Descendente, asc para Ascendente. O padrão é: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. O padrão é: 10.
Mostrar

Ponto de extremidade da API:

GET 
https://yours.com.br/api/v1/links/{id}

Exemplo de solicitação: 

curl --location --request GET 'https://yours.com.br/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Loja

Ponto de extremidade da API:

POST 
https://yours.com.br/api/v1/links

Exemplo de solicitação: 

curl --location --request POST 'https://yours.com.br/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
URL de destino.
domain_id
obrigatório integer
ID do domínio.
alias
opcional string
Alias.
space_id
opcional integer
ID do espaço.
pixel_ids[]
opcional array
IDs de pixel.
redirect_password
opcional string
Redirecionar senha.
sensitive_content
opcional integer
Conteúdo sensível. Os valores possíveis são: 0 para Não, 1 para Sim. O padrão é: 0.
privacy
opcional integer
Privacidade de estatísticas. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha. O padrão é: 0.
password
opcional string
Senha de estatísticas. Funciona apenas com o campo privacy definido como 2.
active_period_start_at
opcional string
Data de início do período ativo no formato Y-m-dTH:i:s.
active_period_end_at
opcional string
Data de término do período ativo no formato Y-m-dTH:i:s.
clicks_limit
opcional integer
Limite de cliques.
expiration_url
opcional string
URL de expiração.
targets_type
opcional string
Segmentação. Os valores possíveis são: continents para Continents, countries para Countries, operating_systems para Operating systems, browsers para Browsers, languages para Languages, devices para Devices, rotations para Rotations.
targets[index][key]
opcional string
Para targets_type=country, o valor deve estar no formato ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
Para targets_type=browsers, os valores possíveis são: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
Para targets_type=devices, os valores possíveis são: Desktop, Mobile, Tablet, Watch, Television.
Para targets_type=languages, o valor deve estar no formato ISO 639-1 alpha-2.
Para targets_type=continents, os valores possíveis são: AF para Africa, AN para Antarctica, AS para Asia, EU para Europe, NA para North America, OC para Oceania, SA para South America.
targets[index][value]
opcional string
URL de destino.
Atualizar

Ponto de extremidade da API:

PUT PATCH 
https://yours.com.br/api/v1/links/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://yours.com.br/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
url
opcional string
URL de destino.
alias
opcional string
Alias.
space_id
opcional integer
ID do espaço.
pixel_ids[]
opcional array
IDs de pixel.
redirect_password
opcional string
Redirecionar senha.
sensitive_content
opcional integer
Conteúdo sensível. Os valores possíveis são: 0 para Não, 1 para Sim.
privacy
opcional integer
Privacidade de estatísticas. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha.
password
opcional string
Senha de estatísticas. Funciona apenas com o campo privacy definido como 2.
active_period_start_at
opcional string
Data de início do período ativo no formato Y-m-dTH:i:s.
active_period_end_at
opcional string
Data de término do período ativo no formato Y-m-dTH:i:s.
clicks_limit
opcional integer
Limite de cliques.
expiration_url
opcional string
URL de expiração.
targets_type
opcional string
Segmentação. Os valores possíveis são: continents para Continents, countries para Countries, operating_systems para Operating systems, browsers para Browsers, languages para Languages, devices para Devices, rotations para Rotations.
targets[index][key]
opcional string
Para targets_type=country, o valor deve estar no formato ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
Para targets_type=browsers, os valores possíveis são: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
Para targets_type=devices, os valores possíveis são: Desktop, Mobile, Tablet, Watch, Television.
Para targets_type=languages, o valor deve estar no formato ISO 639-1 alpha-2.
Para targets_type=continents, os valores possíveis são: AF para Africa, AN para Antarctica, AS para Asia, EU para Europe, NA para North America, OC para Oceania, SA para South America.
targets[index][value]
opcional string
URL de destino.
Excluir

Ponto de extremidade da API:

DELETE 
https://yours.com.br/api/v1/links/{id}

Exemplo de solicitação: 

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