Links

Notes
Expert level
A API key deve ser enviada como um Bearer token no cabeçalho de autorização da solicitação. Gere a sua API key.
List

API endpoint:

GET 
https://short.suiteshare.com/api/v1/links

Exemplo de requisição: 

curl --location --request GET 'https://short.suiteshare.com/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
optional string
The search query.
by
optional string
Search by. Possible values are: title for Título, alias for Alias, url for URL. Defaults to: title.
status
optional integer
Filter by status. Possible values are: 0 for Tudo, 1 for Ativo, 2 for Expired, 3 for Desativado. Defaults to: 0.
space
optional integer
Filter by space id.
domain
optional integer
Filter by domain id.
sort
optional string
Ordenar. Possible values are: desc for Decrescente, asc for Crescente, max for Best performing, min for Least performing. Defaults to: desc.
per_page
optional int
Resultados por página. Possible values are: 10 to 100. Defaults to: 10.
Show

API endpoint:

GET 
https://short.suiteshare.com/api/v1/links/{id}

Exemplo de requisição: 

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

API endpoint:

POST 
https://short.suiteshare.com/api/v1/links

Exemplo de requisição: 

curl --location --request POST 'https://short.suiteshare.com/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
required string
O link a ser encurtado.
alias
optional string
O alias do link .
hash
optional string
The link hash. Ex: /hash-alias
password
optional string
A senha do link.
space
optional integer
O ID do espaço no qual o link será salvo.
domain
optional integer
O ID do domínio no qual o link será salvo.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Ativo, 1 for Desativado. Defaults to: 0.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Publico, 1 for Privado, 2 for Senha. Defaults to: 0.
privacy_password
optional string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
optional string
O link para o qual o usuário será redirecionado quando o link expirar.
expiration_date
optional string
A data de validade do link no formato YYYY-MM-DD.
expiration_time
optional string
O tempo de expiração do link no formato HH:MM.
expiration_clicks
optional integer
O número de cliques após o qual o link deve expirar.
target_type
optional integer
The type of targeting. Possible values are: 0 for Nenhum, 1 for Geographic, 2 for Plataforma, 4 for Rotação.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Update

API endpoint:

PUT PATCH 
https://short.suiteshare.com/api/v1/links/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://short.suiteshare.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
optional string
O link a ser encurtado.
alias
optional string
O alias do link .
hash
optional string
The link hash. Ex: /hash-alias
password
optional string
A senha do link.
space
optional integer
O ID do espaço no qual o link será salvo.
domain
optional integer
O ID do domínio no qual o link será salvo.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Ativo, 1 for Desativado.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Publico, 1 for Privado, 2 for Senha.
privacy_password
optional string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
optional string
O link para o qual o usuário será redirecionado quando o link expirar.
expiration_date
optional string
A data de validade do link no formato YYYY-MM-DD.
expiration_time
optional string
O tempo de expiração do link no formato HH:MM.
expiration_clicks
optional integer
O número de cliques após o qual o link deve expirar.
target_type
optional integer
The type of targeting. Possible values are: 0 for Nenhum, 1 for Geographic, 2 for Plataforma, 4 for Rotação.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Deletar

API endpoint:

DELETE 
https://short.suiteshare.com/api/v1/links/{id}

Exemplo de requisição: 

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