Links

Notes
Especialista
A chave de API deve ser enviada como um token de portador no cabeçalho de autorização da solicitação. Obtenha sua chave de API.
List

API endpoint:

GET 
https://boky.in/api/v1/links

Exemplo de solicitação: 

curl --location --request GET 'https://boky.in/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
optional string
The search query.
search_by
optional string
Procurar por. 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 Expirado, 3 for Desabilitado. Defaults to: 0.
space
optional integer
Filter by space ID.
domain
optional integer
Filter by domain ID.
pixel
optional integer
Filter by pixel ID.
sort_by
optional string
Ordenar por. Possible values are: id for Data Criada, clicks for Cliques, title for Título, alias for Alias, url for URL. Defaults to: id.
sort
optional string
Ordenar. Possible values are: desc for Descendente, asc for Ascendente. Defaults to: desc.
per_page
optional int
Resultados por página. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://boky.in/api/v1/links/{id}

Exemplo de solicitação: 

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

API endpoint:

POST 
https://boky.in/api/v1/links

Exemplo de solicitação: 

curl --location --request POST 'https://boky.in/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
required string
The link to be shortened.
domain
required integer
The domain ID the link to be saved under.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
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 Desabilitado. Defaults to: 0.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Público, 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
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Possible values are: 0 for Nenhum, 1 for Geográfico, 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
O nome da plataforma de destino. 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://boky.in/api/v1/links/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://boky.in/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
The link to be shortened.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
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 Desabilitado.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Público, 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
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Possible values are: 0 for Nenhum, 1 for Geográfico, 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
O nome da plataforma de destino. 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://boky.in/api/v1/links/{id}

Exemplo de solicitação: 

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