Links

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

API endpoint:

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

Exemplo de solicitação: 

curl --location --request GET 'https://jetamigo.com.br/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
A consulta de pesquisa.
by
opcional string
Pesquisar por. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome. Defaults to: title.
status
opcional integer
Filtrar por status. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome, : valor para: nome. Defaults to: 0.
space
opcional integer
Filtrar por ID de espaço.
domain
opcional integer
Filtrar por ID de domínio.
pixel
opcional integer
Filtrar por ID de pixel.
sort
opcional string
Classificar. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome, : valor para: nome. Defaults to: desc.
per_page
opcional int
Resultados por página. Os valores possíveis são: : de para: para. Defaults to: 10.
Mostrar

API endpoint:

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

Exemplo de solicitação: 

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

API endpoint:

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

Exemplo de solicitação: 

curl --location --request POST 'https://jetamigo.com.br/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parâmetro
Tipo
Descrição
url
obrigatório string
O link a ser encurtado.
domain
obrigatório integer
A ID de domínio em que o link será salvo.
alias
opcional string
O alias do link.
password
opcional string
A senha do link.
space
opcional integer
O ID do espaço no qual o link será salvo.
pixels
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Se o link está desabilitado ou não. Os valores possíveis são: : valor para: nome, : valor para: nome. Defaults to: 0.
privacy
opcional integer
Se as estatísticas do link são públicas ou não. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome. Defaults to: 0.
privacy_password
opcional string
A senha da página de estatísticas. Funciona apenas com: campo definido como: valor.
expiration_url
opcional string
O link para onde o usuário será redirecionado quando o link expirar.
expiration_date
opcional string
A data de expiração do link em: formato formato.
expiration_time
opcional string
A hora de expiração do link em: formato formato.
expiration_clicks
opcional integer
O número de cliques após o qual o link deve expirar.
target_type
opcional integer
O tipo de segmentação. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome, : valor para: nome.
country[index][key]
opcional string
O código do país de destino. O código deve estar em: padrão padrão.
country[index][value]
opcional string
O link para onde o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma de destino. Os 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 de destino. O código deve estar em: padrão padrão.
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

API endpoint:

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

Exemplo de solicitação: 

curl --location --request PUT 'https://jetamigo.com.br/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
opcional integer
O ID do espaço no qual o link será salvo.
pixels
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Se o link está desabilitado ou não. Os valores possíveis são: : valor para: nome, : valor para: nome.
privacy
opcional integer
Se as estatísticas do link são públicas ou não. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome.
privacy_password
opcional string
A senha da página de estatísticas. Funciona apenas com: campo definido como: valor.
expiration_url
opcional string
O link para onde o usuário será redirecionado quando o link expirar.
expiration_date
opcional string
A data de expiração do link em: formato formato.
expiration_time
opcional string
A hora de expiração do link em: formato formato.
expiration_clicks
opcional integer
O número de cliques após o qual o link deve expirar.
target_type
opcional integer
O tipo de segmentação. Os valores possíveis são: : valor para: nome, : valor para: nome, : valor para: nome, : valor para: nome.
country[index][key]
opcional string
O código do país de destino. O código deve estar em: padrão padrão.
country[index][value]
opcional string
O link para onde o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma de destino. Os 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 de destino. O código deve estar em: padrão padrão.
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.
Deletar

API endpoint:

DELETE 
https://jetamigo.com.br/links/{id}/destroy

Exemplo de solicitação: 

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