Links

Notas
Nível avançado
A chave API deve ser enviada como token Bearer no cabeçalho Authorization da requisição. Obtenha sua chave API.
Listar

Endpoint da API:

GET 
https://lk.ricioso.com/api/v1/links

Exemplo de requisição: 

curl --location --request GET 'https://lk.ricioso.com/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de busca.
search_by
opcional string
Buscar por. Valores possíveis: title para Título, alias para Apelido, url para URL. Padrão: title.
status
opcional integer
Status. Valores possíveis: 0 para Todos, 1 para Ativo, 2 para Expirado, 3 para Desativado. 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. 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 Descendente, asc para Ascendente. Padrão: desc.
per_page
opcional integer
Resultados por página. Valores possíveis: 10, 25, 50, 100. Padrão: 10.
Exibir

Endpoint da API:

GET 
https://lk.ricioso.com/api/v1/links/{id}

Exemplo de requisição: 

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

Endpoint da API:

POST 
https://lk.ricioso.com/api/v1/links

Exemplo de requisição: 

curl --location --request POST 'https://lk.ricioso.com/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
Apelido.
space_id
opcional integer
ID do espaço.
pixel_ids[]
opcional array
IDs dos pixels.
redirect_password
opcional string
Senha de redirecionamento.
sensitive_content
opcional integer
Conteúdo sensível. Valores possíveis: 0 para Não, 1 para Sim. Padrão: 0.
privacy
opcional integer
Privacidade das estatísticas. Valores possíveis: 0 para Público, 1 para Privado, 2 para Senha. Padrão: 0.
password
opcional string
Senha das 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-d H:i.
active_period_end_at
opcional string
Data de fim do período ativo no formato Y-m-d H:i.
clicks_limit
opcional integer
Limite de cliques.
expiration_url
opcional string
URL de expiração.
targets_type
opcional string
Segmentação. Valores possíveis: 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

Endpoint da API:

PUT PATCH 
https://lk.ricioso.com/api/v1/links/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://lk.ricioso.com/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
URL de destino.
alias
opcional string
Apelido.
space_id
opcional integer
ID do espaço.
pixel_ids[]
opcional array
IDs dos pixels.
redirect_password
opcional string
Senha de redirecionamento.
sensitive_content
opcional integer
Conteúdo sensível. Valores possíveis: 0 para Não, 1 para Sim.
privacy
opcional integer
Privacidade das estatísticas. Valores possíveis: 0 para Público, 1 para Privado, 2 para Senha.
password
opcional string
Senha das 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-d H:i.
active_period_end_at
opcional string
Data de fim do período ativo no formato Y-m-d H:i.
clicks_limit
opcional integer
Limite de cliques.
expiration_url
opcional string
URL de expiração.
targets_type
opcional string
Segmentação. Valores possíveis: 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

Endpoint da API:

DELETE 
https://lk.ricioso.com/api/v1/links/{id}

Exemplo de requisição: 

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