Desenvolvedores

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

Listar todos os links.

Ponto final da API:

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

Exemplo de solicitação:

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

Obtenha os detalhes do link.

Ponto final da API:

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

Exemplo de solicitação:

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

Crie um link.

Ponto final da API:

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

Exemplo de solicitação:

curl --location --request POST 'https://encurtadordelink.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.
alias
opcional string
O alias do link.
password
opcional string
A senha do link.
space
opcional integer
A identificação da categoria no qual o link será salvo.
domain
opcional integer
O ID do domínio no qual o link será salvo.
disabled
opcional integer
Se o link está desativado ou não, o padrão é 0.
public
opcional integer
Se as estatísticas do link são públicas ou não, o padrão é 0.
expiration_url
opcional string
O link para o qual o usuário será redirecionado quando o link expirar.
expiration_date
opcional string
A data de validade do link em YYYY-MM-DD formato.
expiration_time
opcional string
O tempo de expiração do link em HH:MM formato.
expiration_clicks
opcional integer
The number of clicks after which the link should expire.
target_type
opcional integer
The type of targeting, the possible values are: 0 por None, 1 por Geográfico, 2 por Plataforma, 3 por Rotação.
geo[index][key]
opcional string
O código do país de destino. O código deve estar em ISO 3166-1 alpha-2 padrão.
geo[index][value]
opcional string
O link do país para o qual o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma de destino. Valores possíveis são iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
O link da plataforma para onde o usuário será redirecionado.
rotation[index][value]
opcional string
O link de rotação para onde o usuário será redirecionado.
Update

Atualize um link.

Ponto final da API:

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

Exemplo de solicitação:

curl --location --request PUT 'https://encurtadordelink.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
A identificação da categoria no qual o link será salvo.
domain
opcional integer
O ID do domínio no qual o link será salvo.
disabled
opcional integer
Se o link está desativado ou não, o padrão é 0.
public
opcional integer
Se as estatísticas do link são públicas ou não, o padrão é 0.
expiration_url
opcional string
O link para o qual o usuário será redirecionado quando o link expirar.
expiration_date
opcional string
A data de validade do link em YYYY-MM-DD formato.
expiration_time
opcional string
O tempo de expiração do link em HH:MM formato.
expiration_clicks
opcional integer
The number of clicks after which the link should expire.
target_type
opcional integer
The type of targeting, the possible values are: 0 por None, 1 por Geográfico, 2 por Plataforma, 3 por Rotação.
geo[index][key]
opcional string
O código do país de destino. O código deve estar em ISO 3166-1 alpha-2 padrão.
geo[index][value]
opcional string
O link do país para o qual o usuário será redirecionado.
platform[index][key]
opcional string
O nome da plataforma de destino. Valores possíveis são iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
O link da plataforma para onde o usuário será redirecionado.
rotation[index][value]
opcional string
O link de rotação para onde o usuário será redirecionado.
Delete

Delete um link.

Ponto final da API:

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

Exemplo de solicitação:

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